ErrorInfo Class Reference

Describes an AVBlocks error. More...

Inherits Reference.

List of all members.

Public Member Functions
virtual int32_t	code () const =0
	Error code.
virtual ErrorFacility::Enum	facility () const =0
	Error facility.
virtual const char_t *	message () const =0
	Error message.
virtual const char_t *	hint () const =0
	Diagnostic hint.
virtual const char_t *	block () const =0
	The name of the component/block that has generated the error.
virtual const ErrorInfo *	clone () const =0
	Creates a copy of this object.

---

Detailed Description

Describes an AVBlocks error.

---

Member Function Documentation

virtual const char_t* block

(

)

const [pure virtual]

The name of the component/block that has generated the error.

This is useful only when ErrorInfo::facility returns ErrorFacility::Block.

Returns:

Unicode string.

Note:

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

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

Object Management

virtual int32_t code

(

)

const [pure virtual]

Error code.

The value depends on the error facility .

Returns:

Raw error code.

virtual ErrorFacility::Enum facility

(

)

const [pure virtual]

Error facility.

This is the AVBlocks subsystem that has generated 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.

Returns:

Unicode string.

Note:

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

virtual const char_t* message

(

)

const [pure virtual]

Error message.

This is a human-readable description of the error.

Returns:

Unicode string.

Note:

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