Class: TForeignDataException

Declaration: ForeignData.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TForeignDataException is used to report errors from the Data Translation Framework.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TForeignDataException is intended to be used directly. It can also be used as a base class for more specific exceptions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TForeignDataException::TForeignDataException

TForeignDataException (EReason cause)
TForeignDataException (const TForeignDataException & copyMe)
TForeignDataException ()

Interface Category:

API.

Purpose:

Creates a TForeignDataException and specifies the reason the exception is being thrown.
Copy constructor
Default constructor. Used for streaming only.

Calling Context:

Called to create a TForeignDataException and specify the reason the exception is being thrown.
Called to copy an object.
Called by the stream-in operators.

Parameters:

EReason cause -Describes the condition which is causing this TForeignDataException to be thrown.
const TForeignDataException & copyMe -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: TForeignDataException::~TForeignDataException

virtual ~ TForeignDataException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TForeignDataException::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Retrieves the reason this TForeignDataException was thrown.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a member of the EReason enum describing the reason this TForeignDataException was thrown.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TForeignDataException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the TForeignDataException.

Calling Context:

Call directly to throw the exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TForeignDataException::operator=

TForeignDataException & operator =(const TForeignDataException & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TForeignDataException & assign -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:

Not multithread safe.

Other Considerations:

None.

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