Apac.Licensing.LicensedFeature Class Reference

Describes a feature that can be licensed in the application. More...

Public Member Functions
	LicensedFeature (LicensedFeatures feature, DateTime expirationDate)
	Creates a new node-locked feature (a normal key lock). More...
	LicensedFeature (LicensedFeatures feature, DateTime expirationDate, bool nodeLocked, int numLeases)
	Creates a new feature, with numLeases number of leases (floating key lock). If nodeLocked is true then numLeases indicates how many instances can execute on the licensed machine. If nodeLocked is false then numLeases indicates how many instances can execute in the licensed context (as indicated by the license key Key.ContextIdentifier. More...
	LicensedFeature (LicensedFeatures feature, DateTime expirationDate, bool nodeLocked, int numLeases, FeatureType type)
	Creates a new feature, with numLeases number of leases (floating key lock). If nodeLocked is true then numLeases indicates how many instances can execute on the licensed machine. If nodeLocked is false then numLeases indicates how many instances can execute in the licensed context (as indicated by the license key Key.ContextIdentifier. More...
override string	ToString ()
	Outputs a display string for the feature that included the expiration date and the name of the feature. More...

Properties
bool	IsExpired [get]
	Gets if the feature is expired or not. More...
LicensedFeatures	Name [get]
	Descriptive name for the feature. More...
DateTime	ExpirationDate [get]
	The date and time the feature is set to expire in the containing license. More...
int	NumberOfLeases [get]
	The number of leases the feature allows. More...
FeatureType	Type [get]
	Gets the type (see FeatureType). More...

Detailed Description

Describes a feature that can be licensed in the application.

Constructor & Destructor Documentation

LicensedFeature() [1/3]

Apac.Licensing.LicensedFeature.LicensedFeature ( LicensedFeatures  feature, DateTime  expirationDate  )

inline

Creates a new node-locked feature (a normal key lock).

Parameters

feature	The LicensedFeatures describing the feature.
expirationDate	The date that the license key for the feature expires.
numLeases	The number of leases the license key supports.

LicensedFeature() [2/3]

Apac.Licensing.LicensedFeature.LicensedFeature ( LicensedFeatures  feature, DateTime  expirationDate, bool  nodeLocked, int  numLeases  )

inline

Creates a new feature, with numLeases number of leases (floating key lock). If nodeLocked is true then numLeases indicates how many instances can execute on the licensed machine. If nodeLocked is false then numLeases indicates how many instances can execute in the licensed context (as indicated by the license key Key.ContextIdentifier.

Parameters

feature	The LicensedFeatures describing the feature.
expirationDate	The date that the license key for the feature expires.
nodeLocked	Indicates if the feature applies only to the node in the license key or not.
numLeases	The number of leases the license key supports. A value less than one (1) is invalid and will throw an ArgumentOutOfRangeException.

LicensedFeature() [3/3]

Apac.Licensing.LicensedFeature.LicensedFeature ( LicensedFeatures  feature, DateTime  expirationDate, bool  nodeLocked, int  numLeases, FeatureType  type  )

inline

Creates a new feature, with numLeases number of leases (floating key lock). If nodeLocked is true then numLeases indicates how many instances can execute on the licensed machine. If nodeLocked is false then numLeases indicates how many instances can execute in the licensed context (as indicated by the license key Key.ContextIdentifier.

Parameters

feature	The LicensedFeatures describing the feature.
expirationDate	The date that the license key for the feature expires.
nodeLocked	Indicates if the feature applies only to the node in the license key or not.
numLeases	The number of leases the license key supports. A value less than one (1) is invalid and will throw an ArgumentOutOfRangeException.
type	The type of feature being created.

Member Function Documentation

ToString()

override string Apac.Licensing.LicensedFeature.ToString ( )

inline

Outputs a display string for the feature that included the expiration date and the name of the feature.

Returns

Returns a display string for the feature.

Property Documentation

ExpirationDate

DateTime Apac.Licensing.LicensedFeature.ExpirationDate

get

The date and time the feature is set to expire in the containing license.

IsExpired

bool Apac.Licensing.LicensedFeature.IsExpired

get

Gets if the feature is expired or not.

Name

LicensedFeatures Apac.Licensing.LicensedFeature.Name

get

Descriptive name for the feature.

NumberOfLeases

int Apac.Licensing.LicensedFeature.NumberOfLeases

get

The number of leases the feature allows.

Type

FeatureType Apac.Licensing.LicensedFeature.Type

get

Gets the type (see FeatureType).

The type.

---

The documentation for this class was generated from the following file:

• /var/lib/jenkins/workspace/apac/APAC/ApacLicensing/Apac.Licensing/LicensedFeature.cs