Main Page   Namespace List   Compound List   File List   Compound Members   File Members   Related Pages  

XfoInterface::XfoException Class Reference

#include <xfoifc.h>

List of all members.

Public Methods

 XfoException (XfoIfErrorLevel errorLevel, XfoIfErrorCode errorCode, const wchar_t *errorMessage)
 Constructor.

 XfoException (const XfoException &e)
 Copy constructor.

 ~XfoException ()
 Destructor.

XfoIfErrorLevel getErrorLevel () const
 Get the error level.

XfoIfErrorCode getErrorCode () const
 Get the error code.

char * getErrorMessage (char *pVal, int size) const
 Get the error message.

wchar_t * getErrorMessageW (wchar_t *pVal, int size) const
 Get the error message.


Private Attributes

XfoIfErrorLevel m_errorLevel
XfoIfErrorCode m_errorCode
wchar_t * m_errorMessage


Constructor & Destructor Documentation

XfoInterface::XfoException::XfoException XfoIfErrorLevel    errorLevel,
XfoIfErrorCode    errorCode,
const wchar_t *    errorMessage
 

Constructor.

XfoInterface::XfoException::XfoException const XfoException &    e
 

Copy constructor.

XfoInterface::XfoException::~XfoException  
 

Destructor.


Member Function Documentation

XfoIfErrorLevel XfoInterface::XfoException::getErrorLevel   const
 

Get the error level.

Returns:
Returns the error level.

XfoIfErrorCode XfoInterface::XfoException::getErrorCode   const
 

Get the error code.

Returns:
Returns the error code.

char* XfoInterface::XfoException::getErrorMessage char *    pVal,
int    size
const
 

Get the error message.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoException::getErrorMessageW wchar_t *    pVal,
int    size
const
 

Get the error message.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.


Member Data Documentation

XfoIfErrorLevel XfoInterface::XfoException::m_errorLevel [private]
 

XfoIfErrorCode XfoInterface::XfoException::m_errorCode [private]
 

wchar_t* XfoInterface::XfoException::m_errorMessage [private]
 


The documentation for this class was generated from the following file:
Generated on 18 Mar 2016 for AHFormatter C/C++ Interface by Doxygen 1.3-rc2