ErrorInfo Class Reference

Describes a PrimoBurner error. More...

#include <pb_api.h>

Inherits Reference.

Public Member Functions
virtual const ErrorInfo *	clone () const =0
	Creates a copy of this object.
virtual int32_t	code () const =0
	Gets the error code.
virtual ErrorFacility::Enum	facility () const =0
	Gets the error facility.
virtual const char_t *	message () const =0
	Gets 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 a PrimoBurner error.

Member Function Documentation

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

Object Management

code()

virtual int32_t code ( ) const

pure virtual

Gets the error code.

It must be interpreted in terms of the error facility .

Returns

The raw error code.

facility()

virtual ErrorFacility::Enum facility ( ) const

pure virtual

Gets the error facility.

This is the PrimoBurner subsystem that has generated the error.

Returns

A facility value from the ErrorFacility enum.

message()

virtual const char_t * message ( ) const

pure virtual

Gets the error message.

This is a human-readable description of the error.

Returns

A null-terminated string of the message.