VxSdk::IVxLicenseFeature Struct Reference

Represents device functionality that is enabled with a valid license. More...

#include <IVxLicenseFeature.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	GetCommissionedDevices (VxCollection< IVxDevice ** > &deviceCollection) const =0
	Gets the devices that have been commissioned for this feature. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

Public Attributes
bool	isPending
	Indicates whether this is a "pending" feature, which does not enable any device functionality, or a normal feature that does. More...
char	activationId [64]
	The activation identifier. More...
char	expiration [64]
	The date and time at which the feature will expire. More...
char	id [64]
	The unique identifier of the feature. More...
char	installation [64]
	The date and time at which the feature was installed on the host. More...
char	name [64]
	The name of the feature. More...
char	version [64]
	The feature version. More...
int	count
	The allowable commisions count. More...
int	used
	The amount of the allowable count that is currently used by commissions. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents device functionality that is enabled with a valid license.

Definition at line 13 of file IVxLicenseFeature.h.

Member Function Documentation

void VxSdk::IVxLicenseFeature::Clear ( )

inlineprotected

Clears this instance.

Definition at line 76 of file IVxLicenseFeature.h.

                     {
            isPending = false;
            VxZeroArray(this->activationId);
            VxZeroArray(this->expiration);
            VxZeroArray(this->id);
            VxZeroArray(this->installation);
            VxZeroArray(this->name);
            VxZeroArray(this->version);
            count = 0;
            used = 0;
        }

virtual VxResult::Value VxSdk::IVxLicenseFeature::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxLicenseFeature::GetCommissionedDevices ( VxCollection< IVxDevice ** > &  deviceCollection ) const

pure virtual

Gets the devices that have been commissioned for this feature.

Available filters: kAllTags, kAllPrivateTags, kModifiedSince.

Parameters

deviceCollection

A VxCollection of the devices that have been commissioned for this feature.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxLicenseFeature::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

Member Data Documentation

char VxSdk::IVxLicenseFeature::activationId[64]

The activation identifier.

Definition at line 42 of file IVxLicenseFeature.h.

int VxSdk::IVxLicenseFeature::count

The allowable commisions count.

Definition at line 66 of file IVxLicenseFeature.h.

char VxSdk::IVxLicenseFeature::expiration[64]

The date and time at which the feature will expire.

Definition at line 46 of file IVxLicenseFeature.h.

char VxSdk::IVxLicenseFeature::id[64]

The unique identifier of the feature.

Definition at line 50 of file IVxLicenseFeature.h.

char VxSdk::IVxLicenseFeature::installation[64]

The date and time at which the feature was installed on the host.

Definition at line 54 of file IVxLicenseFeature.h.

bool VxSdk::IVxLicenseFeature::isPending

Indicates whether this is a "pending" feature, which does not enable any device functionality, or a normal feature that does.

Definition at line 38 of file IVxLicenseFeature.h.

char VxSdk::IVxLicenseFeature::name[64]

The name of the feature.

Definition at line 58 of file IVxLicenseFeature.h.

int VxSdk::IVxLicenseFeature::used

The amount of the allowable count that is currently used by commissions.

Definition at line 70 of file IVxLicenseFeature.h.

char VxSdk::IVxLicenseFeature::version[64]

The feature version.

Definition at line 62 of file IVxLicenseFeature.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/IVxLicenseFeature.h