![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
None.
Purpose:
The concrete class TLicenseProduct represents a product that is licensed through the Licensing framework. The product is identified by its unique VendorId, ProductId, ProductVersion triplet. The TLicenseProduct class also maintains a Product Name object that should contain the human-readable and localizable description of the product.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TLicenseProduct ()
- TLicenseProduct (const TLicenseProduct & source)
- TLicenseProduct (const TLicenseVendorIdentifier & vendorId, const TLicenseProductIdentifier & productId, const TLicenseVersion productVersion, const TText & productName)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
- Constructs and initializes.
Calling Context:
- Called by the stream-in operators.
- Called to copy an object.
- Called by the product and provider.
Parameters:
- Takes no parameters.
- const TLicenseProduct & source -The object to copy.
- const TLicenseVendorIdentifier & vendorId -The vendor's unique identifier.
- const TLicenseProductIdentifier & productId -The product's unique identifier.
- const TLicenseVersion productVersion -The product version.
- const TText productName -The product's human-readable name.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TLicenseProduct ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TLicenseProduct & operator =(const TLicenseProduct & source)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
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.
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -The stream the object streams itself in from.
Return Value:
Returns a reference to the stream the object streams itself in from.
Exceptions:
Throws TInvalidVersionException if the version of the object is not recognized.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -The stream the object streams itself out to.
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: TLicenseProduct::GetProductName
virtual void GetProductName (TText & target) const
Interface Category:
API.
Purpose:
Gets the human-readable and localized name of the licensed product.
Calling Context:
Called to query an object for its presentable product name.
Parameters:
- TText & target -The storage where the name is copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TLicenseProduct::GetProductVersion
virtual void GetProductVersion (TLicenseVersion & target) const
Interface Category:
API.
Purpose:
Gets the version component of the product.
Calling Context:
Called to query a TLicenseProduct for its version.
Parameters:
- TLicenseVersion & target -The storage where the version is copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TLicenseProduct::GetVendorIdentifier
virtual void GetVendorIdentifier (TLicenseVendorIdentifier & target) const
Interface Category:
API.
Purpose:
Gets the product vendor's unique identifier.
Calling Context:
Called to query an object for its vendor identifier.
Parameters:
- TLicenseVendorIdentifier & target -The storage where the vendor identifier is copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TLicenseProduct::GetProductIdentifier
virtual void GetProductIdentifier (TLicenseProductIdentifier & target) const
Interface Category:
API.
Purpose:
Gets the product's unique identifier.
Calling Context:
Called to query the TLicenseProduct object for its product identifier.
Parameters:
- TLicenseProductIdentifier & target -The storage where the product's version is copied.
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.
Copyright©1995 Taligent,Inc. All rights reserved.