Class: TTokenException

Declaration: Tokens.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TTokenException, derived from TStandardException, is thrown to identify exception conditions caused by TToken.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTokenException::TTokenException

TTokenException ()
TTokenException (ETokenExceptionID id)
TTokenException (const TTokenException &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a TTokenException with a specific error ID.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct a TTokenException with a specific error ID.
Called to copy an object.

Parameters:

Takes no parameters.
ETokenExceptionID id -The error ID of this exception.
const TTokenException & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTokenException::~TTokenException

virtual ~ TTokenException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTokenException::operator=

TTokenException & operator =(const TTokenException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTokenException & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTokenException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the TTokenException.

Calling Context:

Called to throw an exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTokenException::GetReason

ETokenExceptionID GetReason () const

Interface Category:

API.

Purpose:

Gets the reason why the exception was thrown.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The reason why the exception was thrown.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.