ErrorInfo Class Reference

Describes an error interface used for uniform error handling across all Primo Software libraries. More...

#include <PrimoError.h>

Inherits Reference.

Public Member Functions
virtual const char_t *	block () const =0
	The component that has generated the error. More...
virtual const ErrorInfo *	clone () const =0
	Creates a copy of this object. More...
virtual int32_t	code () const =0
	Error code. More...
virtual int32_t	facility () const =0
	Error facility. More...
virtual const char_t *	hint () const =0
	Diagnostic hint. More...
virtual const char_t *	message () const =0
	Error message. More...
Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance. More...
virtual int32_t	retain () const =0
	Retains the instance. More...
virtual int32_t	retainCount () const =0
	Returns the current reference count. More...

Detailed Description

Describes an error interface used for uniform error handling across all Primo Software libraries.

Member Function Documentation

virtual const char_t* block ( ) const

pure virtual

The component that has generated the error.

Note

The returned string is never NULL. It is an empty string when the component is not set.

Returns

Unicode string.

virtual const ErrorInfo* clone ( ) const

pure virtual

Creates a copy of this object.

Returns

A new ErrorInfo object. The caller is responsible for releasing the new object when it is not needed anymore.

See Also

primo::Reference::release

virtual int32_t code ( ) const

pure virtual

Error code.

Its meaning depends on the error facility .

Returns

The error code as defined by the appropriate error facility.

virtual int32_t facility ( ) const

pure virtual

Error facility.

This is the component that reports the error.

Returns

An ErrorFacility constant.

virtual const char_t* hint ( ) const

pure virtual

Diagnostic hint.

This is an implementation specific diagnostics message, suitable for error logs or debugging.

Note

The returned string is never NULL. It is an empty string when the error hint is not set.

Returns

Unicode string.

virtual const char_t* message ( ) const

pure virtual

Error message.

This is a textual representation of the error code.

Note

The returned string is never NULL. It is an empty string when the error hint is not set.

Returns

Unicode string.