XMP_Error Class Reference

XMP Toolkit error, associates an error code with a descriptive error string. More...

#include <XMP_Const.h>

List of all members.

Public Member Functions

 XMP_Error (XMP_Int32 _id, XMP_StringPtr _errMsg)
 Constructor for an XMP_Error.
XMP_Int32 GetID () const
 Retrieves the numeric code from an XMP_Error.
XMP_StringPtr GetErrMsg () const
 Retrieves the descriptive string from an XMP_Error.
XMP_Bool IsNotified () const
 Retrieves the information whether particular error is notified or not.
void SetNotified ()
 Sets the notification status for an error.

Private Attributes

XMP_Int32 id
 Exception code. See constants kXMPErr_Unknown and following.
XMP_StringPtr errMsg
XMP_Bool notified
 Variable to store whether this particular error is notified to user or not.

Detailed Description

XMP Toolkit error, associates an error code with a descriptive error string.


Constructor & Destructor Documentation

XMP_Error::XMP_Error ( XMP_Int32  _id,
XMP_StringPtr  _errMsg 
) [inline]

Constructor for an XMP_Error.

Parameters:
_id The numeric code.
_errMsg The descriptive string, for debugging use only. It must not be shown to users in a final product. It is written for developers, not users, and never localized.

Member Data Documentation

Descriptive string, for debugging use only. It must not be shown to users in a final product. It is written for developers, not users, and never localized.

Referenced by GetErrMsg().


The documentation for this class was generated from the following file:

XMP-Toolkit-SDK-CC201306 documentation generated by doxygen 1.6.3