Class: TCancelWaitException

Declaration: KernelExceptions.h

Taxonomy Categories:

Member Functions:

TCancelWaitException
operator=
~TCancelWaitException
GetReason
Throw

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Defines an exception for CancleWaitPostExceptions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCancelWaitException::TCancelWaitException

TCancelWaitException (EReason whatHappened, NATIVE_ERROR_TYPE NativeErrorCode =0)
TCancelWaitException (const TCancelWaitException & copy)
TCancelWaitException ()

Interface Category:

API.

Purpose:

Constructs an object from EReason and error data.
Copy constructor.
Default constructor.

Calling Context:

Called to construct an object from EReason and error data.
Called to copy an object.
Called by the stream-in operators and derived classes.

Parameters:

EReason whatHappened -The error code for what happened.
NATIVE_ERROR_TYPE NativeErrorCode =0 -The actual error code from the underlying operating system.
const TCancelWaitException & copy -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCancelWaitException::operator=

TCancelWaitException & operator =(const TCancelWaitException & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCancelWaitException & copy -The object to be copied.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCancelWaitException::~TCancelWaitException

virtual ~ TCancelWaitException ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TCancelWaitException::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Gets the reason for the exception.

Calling Context:

Called to get the reason for the exception.

Parameters:

Takes no parameters.

Return Value:

Returns EReason for the exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCancelWaitException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the exception.

Calling Context:

Called by the client code to throw the exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws the exception requested.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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