Class: TLicenseDenied

Declaration: LicenseErrors.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLicenseException

Inherited By:

None.

Purpose:

The concrete class that is thrown by the Licensing framework when a license request fails. TLicenseDenied is a composite exception that contains a collection of all exceptions that occurred during the license request.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLicenseDenied::TLicenseDenied

TLicenseDenied (EReason whatHappened, TDequeOf < TLicenseExceptionReport > & reports)
TLicenseDenied (const TLicenseDenied & copy)

Interface Category:

API.

Purpose:

Creates and initializes an object.
Copy constructor.

Calling Context:

Called to create an exception.
Called to copy an object.

Parameters:

EReason whatHappened -Reason license request failed.
TDequeOf < TLicenseExceptionReport > & reports -Collection of
exceptions that occurred while performing license request.
const TLicenseDenied & copy -Object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TLicenseDenied::operator=

TLicenseDenied & operator =(const TLicenseDenied & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLicenseDenied & 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: TLicenseDenied::~TLicenseDenied

virtual ~ TLicenseDenied ()

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: TLicenseDenied::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: TLicenseDenied::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 TInvalidVersionError if the object's version is not supported.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseDenied::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: TLicenseDenied::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 TLicenseDenied unconditionally.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLicenseDenied::GetReportIterator

virtual void GetReportIterator (TDeleterFor < TIteratorOver < TLicenseExceptionReport > >&)

Interface Category:

API.

Purpose:

Gets a copy of the iterator over the exception reports.

Calling Context:

Called while processing the exception.

Parameters:

TDeleterFor < TIteratorOver < TLicenseExceptionReport > >& -Iterator over TLicenseExceptionReports.

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.