DVDBuilder for C++  3.4
DVD Authoring Software Development Kit
ErrorInfo Class Referenceabstract

Describes a DVDBuilder error. More...

Inheritance diagram for ErrorInfo:
Reference

Public Member Functions

virtual const ErrorInfoclone () const =0
 Creates a copy of this object. More...
 
virtual int32_t code () const =0
 Error code. More...
 
virtual ErrorFacility::Enum 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 a DVDBuilder error.

Member Function Documentation

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
The error code as defined by the appropriate error facility.
virtual ErrorFacility::Enum facility ( ) const
pure virtual

Error facility.

This is the DVDBuilder 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.
virtual const char_t* message ( ) const
pure virtual

Error message.

This is a textual representation of the error code.

Returns
Unicode string.