Class: TInvalidParameter

Declaration: GenericExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Thrown when an invalid parameter is passed to a function.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive for more specific exception.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Derived classes may not add 'reasons' (EReason is scoped to this class).

Member Function: TInvalidParameter::TInvalidParameter

TInvalidParameter ()
TInvalidParameter (EReason whatHappened)
TInvalidParameter (const TInvalidParameter & copy)

Interface Category:

API.

Purpose:

Default constructor.
Construct exception with a specific reason.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an instance to assign to.
Called when an error is detected.
Called to copy an object.

Parameters:

Takes no parameters.
EReason whatHappened -The specific reason for the exception.
const TInvalidParameter & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TInvalidParameter::operator=

TInvalidParameter & operator =(const TInvalidParameter & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TInvalidParameter & copy -The object to copy.

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: TInvalidParameter::~TInvalidParameter

virtual ~ TInvalidParameter ()

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: TInvalidParameter::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Returns the reason that the exception was thrown.

Calling Context:

Called to determine what caused the exception.

Parameters:

Takes no parameters.

Return Value:

An enumeration tag that represents the exception type.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TInvalidParameter::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Used to polymorphically throw an exception.

Calling Context:

Called to throw an exception of this type.

Parameters:

Takes no parameters.

Return Value:

None.

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.