DWFCore::DWFException Class Reference

#include "dwfcore/Exception.h"

Inheritance diagram for DWFCore::DWFException:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFException:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for all exceptions.

Since:
1.0.1
An exception class that contains information detailing the error event.

Definition at line 46 of file Exception.h.

Public Member Functions

virtual _DWFCORE_API ~DWFException () throw ()
_DWFCORE_API DWFException (const DWFException &) throw ()
_DWFCORE_API DWFExceptionoperator= (const DWFException &) throw ()
virtual _DWFCORE_API const
wchar_t * 
type () const =0 throw ()
_DWFCORE_API const wchar_t * message () const throw ()
_DWFCORE_API const char * function () const throw ()
_DWFCORE_API const wchar_t * file () const throw ()
_DWFCORE_API unsigned int line () const throw ()

Protected Member Functions

_DWFCORE_API DWFException (const wchar_t *zMessage, const char *zFunction, const wchar_t *zFile, unsigned int nLine) throw ()


Constructor & Destructor Documentation

virtual _DWFCORE_API DWFCore::DWFException::~DWFException  )  throw () [virtual]
 

Destructor

Exceptions:
None 

_DWFCORE_API DWFCore::DWFException::DWFException const DWFException  )  throw ()
 

Copy Constructor This constructor will only make a copy of the message string member. Other member pointers will be copied by reference since they should should be string literals.

Exceptions:
None 

_DWFCORE_API DWFCore::DWFException::DWFException const wchar_t *  zMessage,
const char *  zFunction,
const wchar_t *  zFile,
unsigned int  nLine
throw () [protected]
 

Constructor

Parameters:
zMessage Describes the exception event. This string is copied into a local buffer and is limited to 512 wide characters.
zFunction The function in which the event occured. The __func__ macro is recommended.
zFile The file in which the event occured. The __FILE__ macro is recommended.
nLine The line number in the file in which the event occured. The __LINE__ macro is recommended.
Exceptions:
None 


Member Function Documentation

_DWFCORE_API const wchar_t* DWFCore::DWFException::file  )  const throw ()
 

Returns a character string describing the file in which the exception occured.

Returns:
The file name.
Exceptions:
None 

_DWFCORE_API const char* DWFCore::DWFException::function  )  const throw ()
 

Returns a character string describing the function in which the exception occured.

Returns:
The function name.
Exceptions:
None 

_DWFCORE_API unsigned int DWFCore::DWFException::line  )  const throw ()
 

Returns the line in the file in which the exception occured.

Returns:
The line number.
Exceptions:
None 

_DWFCORE_API const wchar_t* DWFCore::DWFException::message  )  const throw ()
 

Returns a wide character string describing the exception event.

Returns:
The message string.
Exceptions:
None 

_DWFCORE_API DWFException& DWFCore::DWFException::operator= const DWFException  )  throw ()
 

Assignment Operator This operator will only make a copy of the message string member. Other member pointers will be copied by reference since they should should be string literals.

Exceptions:
None 

virtual _DWFCORE_API const wchar_t* DWFCore::DWFException::type  )  const throw () [pure virtual]
 

Returns a wide character string describing the exception type, usually the class name.

Returns:
The type string.
Exceptions:
None 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:36 2009 for Autodesk DWF Core Library by  doxygen 1.4.5