Class: TVirtualKeyboardException

Declaration: Keyboards.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Indicates exceptional situations within the virtual keyboard classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TVirtualKeyboardException::TVirtualKeyboardException

TVirtualKeyboardException ()
TVirtualKeyboardException (EVirtualKeyboardExceptionID error)
TVirtualKeyboardException (const TVirtualKeyboardException & copy)

Interface Category:

API.

Purpose:

Default constructor.
Creates an exception for the specified error.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called internally.
Called to copy an object.

Parameters:

Takes no parameters.
EVirtualKeyboardExceptionID error -The error ID for this exception.
const TVirtualKeyboardException & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TVirtualKeyboardException::operator=

TVirtualKeyboardException & operator =(const TVirtualKeyboardException & rhs)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TVirtualKeyboardException & rhs -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:

Not multithread safe.

Other Considerations:

None.

Member Function: TVirtualKeyboardException::~TVirtualKeyboardException

virtual ~ TVirtualKeyboardException ()

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: TVirtualKeyboardException::GetErrorID

void GetErrorID (EVirtualKeyboardExceptionID & id) const

Interface Category:

API.

Purpose:

Returns the error ID for this exception.

Calling Context:

Called to get the error ID for this exception.

Parameters:

EVirtualKeyboardExceptionID & id -The error ID for this exception.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TVirtualKeyboardException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called during exception generation. Typically not called directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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