Class: TElfinLicenseData

Declaration: Elfin.h

Taxonomy Categories:

Member Functions:

Interface Category:

API (3rd party product).

Inherits From:

TProviderOperation

Inherited By:

None.

Purpose:

TElfinLicenseData allows the licensed product calling TLicenseUse::Check to get ELM-specific information about the activation key for the ELM feature being licensed.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. necessary

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TElfinLicenseData::TElfinLicenseData

TElfinLicenseData ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the stream-in operator.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseData::~TElfinLicenseData

virtual ~ TElfinLicenseData ()

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

TElfinLicenseData & operator =(const TElfinLicenseData &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TElfinLicenseData & -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: TElfinLicenseData::operator>>=

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

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -Target 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: TElfinLicenseData::GetOperationType

virtual void GetOperationType (TStandardText & token) const

Interface Category:

API.

Purpose:

Overrides the base class function. Retrieves the operation type represented by this object.

Calling Context:

Called to get type of operation

Parameters:

TStandardText & token -Storage to which the operation type is copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TElfinLicenseData::GetAlias

const TText & GetAlias () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the alias of the feature.

Calling Context:

Called to determine alias of a feature

Parameters:

Takes no parameters.

Return Value:

Returns a TText reference to the alias.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetVendorData

const TText & GetVendorData () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the vendor data.

Calling Context:

Called to get vendor data.

Parameters:

Takes no parameters.

Return Value:

Returns a TText reference to the vendor data

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetStartsOn

const TTime & GetStartsOn () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the first date at which the feature may be used.

Calling Context:

Called to determine when a feature may begin to be used.

Parameters:

Takes no parameters.

Return Value:

Returns a TTime reference to the start date.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetExpiresOn

const TTime & GetExpiresOn () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the expiration date of the feature.

Calling Context:

Called to determine when a feature expires.

Parameters:

Takes no parameters.

Return Value:

Returns a TTime reference to the expire date

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetInstalledOn

const TTime & GetInstalledOn () const

Interface Category:

API.

Purpose:

Gets ELM-specific information.Gets the date the feature was installed on.

Calling Context:

Called to determine when a feature was installed.

Parameters:

Takes no parameters.

Return Value:

Returns a TTime reference to the install date.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetTotalUnits

const TLicenseUnit & GetTotalUnits () const

Interface Category:

API.

Purpose:

Gets ELM-specific information.Gets, namely the total number of license units defined for the feature.

Calling Context:

Called to determine the total number of license units.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnit reference to the number of license units.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetSoftTotalUnits

const TLicenseUnit & GetSoftTotalUnits () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the total number of soft license units.

Calling Context:

Called to determine the total number of soft license units.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnit reference to the number of license units.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetTotalReserved

const TLicenseUnit & GetTotalReserved () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the total number of license units reserved in the resource file for this feature.

Calling Context:

Called to determine the number of units in reserved pool.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnit reference to the reserved pool.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetUsedFromReservePool

const TLicenseUnit & GetUsedFromReservePool () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the number of license units currently in use, allocated from the reserve license pool.

Calling Context:

Called to determine number of license units currently in use from reserved pool.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnit reference to the number of used license units from reserved pool.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetOtherUsed

const TLicenseUnit & GetOtherUsed () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the number of licenses currently in use, allocated from the free license pool.

Calling Context:

Called to determine number of license units currently in use from free pool.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnits reference to the number of used license units from free pool.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetAvailableToMe

const TLicenseUnit & GetAvailableToMe () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the total number of license units currently available to the current user and host.

Calling Context:

Called to determine number of license units available to the current user.

Parameters:

Takes no parameters.

Return Value:

Returns a TLicenseUnit reference to the number of available units.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetNodeLocked

bool GetNodeLocked () const

Interface Category:

API.

Purpose:

Gets ELM-specific information. Determines if the key is node locked or not.

Calling Context:

Called to determine if key is node-locked or floating.

Parameters:

Takes no parameters.

Return Value:

Returns true if key is node locked false if key is floating.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetResourceAttached

bool GetResourceAttached () const

Interface Category:

API.

Purpose:

Gets ELM-specific information. Determines if key specifies a resource file to be autoloaded.

Calling Context:

Called to determine if resource file is specified to autoload.

Parameters:

Takes no parameters.

Return Value:

Returns true if resource file to be autoloaded, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetDomain

char GetDomain () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the network class of the key. Clients must be in the same domain as server to check out such licenses.

Calling Context:

Called to determine network domain of key.

Parameters:

Takes no parameters.

Return Value:

Returns A, B, or C depending on domain.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Only valid if GetStatus returns a non-negative value. Refer to the Elan License Manager Documentation.

Member Function: TElfinLicenseData::GetStatus

signed long GetStatus () const

Interface Category:

API.

Purpose:

Gets ELM-specific information, namely the status of the elm_getinfo, call.

Calling Context:

This function would have to be called to determine if the LicenseData operation succeeded.

Parameters:

Takes no parameters.

Return Value:

A positive return value indicates success. This implies that all other Get calls would return valid data. Zero indicates no more features available. A negative value indicates an error code.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Refer to the Elan License Manager Documentation.

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