Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages   Examples  

CComException Class Reference

Inheritance diagram for CComException:

CException List of all members.

Public Methods

 CComException (com_result=com_false, const char *=ms_DefaultMessage)
 CComException (const CComException &)
virtual std::string What (void) const
virtual std::string Type (void) const
bool operator== (const com_result &Result) const
bool operator!= (const com_result &Result) const
 operator com_result () const
com_result GetResult (void) const
bool Failed () const
bool Succeeded () const
std::string GetResultDescription (void) const

Detailed Description

Class primary destinated for the Hyperion Component. Try to mix the mechanisms of the C++ exception and the result code of the COM model. So each exception class is identified by a result code.


Constructor & Destructor Documentation

CComException::CComException ( com_result Result = com_false,
const char * Doc = ms_DefaultMessage )
 

If the result code designed a failed code, the full documentation of the exception will be traced in the CERR file. The full documentation is composed by :

  • the documentation of the code result
  • the complementary documentation corresponded to m_Doc member
    Parameters:
    Result   the result code of the object
    pDoc   the complementary documentation of the exception

CComException::CComException ( const CComException & Error )
 

The exception generated by the copy constructor doesn't write its error description in the CERR file.


Member Function Documentation

com_result CComException::GetResult ( void ) const [inline]
 

Get the result code.

std::string CComException::GetResultDescription ( void ) const
 

Get the description of the result code.

Returns:
Description of the result code.

std::string CComException::Type ( void ) const [virtual]
 

Give the type of exception. Redefined by each exception class.

Reimplemented from CException.

std::string CComException::What ( void ) const [virtual]
 

Give the full documentation of the object.

Reimplemented from CException.


The documentation for this class was generated from the following files:
Top of Page
written by Pierre Rebours © 2000-2001. Terms of Use.