ErrorInfo Class Reference

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

#include <error.h>

Inheritance diagram for ErrorInfo:

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

Detailed Description

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

Member Function Documentation

block()

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.

clone()

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

code()

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.

facility()

virtual int32_t facility ( ) const

pure virtual

Error facility.

This is the component that reports the error.

Returns

An ErrorFacility constant.

hint()

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.

message()

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.

setBlock()

virtual void setBlock ( const char_t *  block )

pure virtual

Sets or clears the error block.

It is the component that has generated the error.

Parameters

block

A pointer to zero terminated Unicode string. Can be NULL in which case the error block is cleared.

setCode()

virtual void setCode ( int32_t  code )

pure virtual

Sets the error code.

Its meaning depends on the error facility .

Parameters

code	An error code

setFacility()

virtual void setFacility ( int32_t  facility )

pure virtual

Sets the error faiclity.

This is the component that reports the error.

Parameters

facility

An Error facility constant

setHint()

virtual void setHint ( const char_t *  hint )

pure virtual

Sets or clears the error hint.

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

Parameters

hint	A pointer to zero terminated Unicode string. Can be NULL in which case the error hint is cleared.

setMessage()

virtual void setMessage ( const char_t *  message )

pure virtual

Sets or clears the error message.

It is a textual representation of the error code.

Parameters

message

A pointer to zero terminated Unicode string. Can be NULL in which case the error message is cleared.