LicenseInfo Class Reference

Provides information about the current license state of the library. More...

#include <PrimoLicense.h>

Inherits Reference.

Public Member Functions
virtual bool_t	isLicensed (const char *product, const char *feature)=0
	Checks whether a product feature is licensed. More...
virtual int32_t	licenseStatus ()=0
	Gets the current license status. More...
Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance. More...
virtual int32_t	retain () const =0
	Retains the instance. More...
virtual int32_t	retainCount () const =0
	Returns the current reference count. More...

Detailed Description

Provides information about the current license state of the library.

A LicenseInfo object is obtained by calling Library::createLicenseInfo() The created object must be released when it is not needed anymore.

See Also

Library::createLicenseInfo

Member Function Documentation

virtual bool_t isLicensed ( const char *  product, const char *  feature  )

pure virtual

Checks whether a product feature is licensed.

Parameters

product	The product Id. If NULL the default library product is implied.
feature	The feature Id. If NULL the default product feature is implied.

Returns

TRUE if the specified product feature is licensed, FALSE otherwise.

Remarks

If a product is fully licensed then the function will always return TRUE for that product regardless of the feature parameter.

If a product is licensed for a limited set of features then the function will return TRUE for that product only if the feature parameter specifies one of the licensed features or is NULL.

virtual int32_t licenseStatus ( )

pure virtual

Gets the current license status.

Returns

A combination of flags defined in LicenseStatusFlags::Enum.

Remarks

Demo builds cannot be licensed. For demo builds, this method always returns LicenseStatusFlags::DemoBuild.

See Also

LicenseStatusFlags