Class Hierarchy   Class Index   Method Index  

CHMerror Class Reference

#include <CHMerrorClass.h>

Detailed Description

Chameleon exception class.

This is the only exception that should be thrown by the Chameleon code. This exception class may inherit from other exception classes depending on the environment. For MFC for instance, the CHMerror class is defined to inherit from the CException class. For other compilers the CHMerror class is just a stand-alone class.


Public Member Functions

const long Code () const
 Get the error code.
unsigned int CountOfParameter () const
 Get the number of parameters.
CHMchar * Description () const
 Get the description of the error.
CHMstring Dump () const
 Output the error information to a string.
CHMboolean HasParameter (const CHMchar *pKey) const
 Check whether a parameter with this name is present.
const char * Parameter (const CHMchar *pKey) const
 Get the parameter referenced by the key pKey.
const char * ParameterName (unsigned int Index) const
 Get the name of a parameter by sequence number.

Member Function Documentation

const long CHMerror::Code (   )  const
 

Get the error code.

unsigned int CHMerror::CountOfParameter (   )  const
 

Get the number of parameters.

CHMchar* CHMerror::Description (   )  const
 

Get the description of the error.

CHMstring CHMerror::Dump (   )  const
 

Output the error information to a string.

This is useful for diagnostics.

CHMboolean CHMerror::HasParameter (  const CHMchar *  pKey  )  const
 

Check whether a parameter with this name is present.

const char* CHMerror::Parameter (  const CHMchar *  pKey  )  const
 

Get the parameter referenced by the key pKey.

const char* CHMerror::ParameterName (  unsigned int  Index  )  const
 

Get the name of a parameter by sequence number.

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