Class: TElfinLicenseFailed

Declaration: Elfin.h

Taxonomy Categories:

Member Functions:

Interface Category:

API (3rd party product).

Inherits From:

TLicenseException

Inherited By:

None.

Purpose:

A derived class of TLicenseException to indicate License denied errors.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TElfinLicenseFailed::TElfinLicenseFailed

TElfinLicenseFailed (EReason whatHappened, const TText & message)
TElfinLicenseFailed (const TElfinLicenseFailed & copy)

Interface Category:

API.

Purpose:

Creates and initializes object.
Copy constructor.

Calling Context:

Called to create an object
Called to copy an object.

Parameters:

EReason whatHappened -The reason for the exception
const TText & message -Message returned from ELM
const TElfinLicenseFailed & copy -Object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseFailed::operator=

TElfinLicenseFailed & operator =(const TElfinLicenseFailed & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TElfinLicenseFailed & copy -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.

Member Function: TElfinLicenseFailed::~TElfinLicenseFailed

virtual ~ TElfinLicenseFailed ()

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: TElfinLicenseFailed::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -Target stream.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseFailed::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -Source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseFailed::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Overrides inherited TStandardException function.

Calling Context:

Called to query object for details.

Parameters:

Takes no parameters.

Return Value:

Returns error code.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseFailed::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Overrides inherited TStandardException function.

Calling Context:

Same as TStandardException function

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws TElfinLicenseFailed unconditionally.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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