The License class represents license information for the resource that owns this resource. More...

#include <License.h>

Public Types
enum	SystemLicenseTypes { SystemLicenseTypes::Unknown, SystemLicenseTypes::Enterprise, SystemLicenseTypes::Ultimate, SystemLicenseTypes::Unlicensed }
	Values that represent the types of system licenses. More...

Public Member Functions
	License (VxSdk::IVxLicense *vxLicense)
	Constructor. More...

virtual	~License ()
	Destructor. More...

	!License ()
	Finaliser. More...

Package Functions
System::Collections::Generic::List< LicenseFeature^ >^	_GetLicenseFeatures ()

Package Attributes
VxSdk::IVxLicense *	_license

Properties
System::String^	CompanyName `[get]`
	Gets the friendly name of the owning company/organization. More...

System::Collections::Generic::List< LicenseFeature^ >^	LicenseFeatures `[get]`
	Gets the features this license contains. More...

SystemLicenseTypes	SystemLicenseType `[get]`
	Gets the type of system that this license is applied to. More...

Detailed Description

The License class represents license information for the resource that owns this resource.

Definition at line 14 of file License.h.

Member Enumeration Documentation

enum CPPCli::License::SystemLicenseTypes

strong

Values that represent the types of system licenses.

Enumerator
Unknown	An error or unknown value was returned.
Enterprise	Enterprise system license.
Ultimate	Ultimate system license.
Unlicensed	Unlicensed system.

Definition at line 20 of file License.h.

                                       {
             Unknown,
 
             Enterprise,
 
             Ultimate,
 
             Unlicensed
         };

Constructor & Destructor Documentation

CPPCli::License::License ( VxSdk::IVxLicense * vxLicense )

Constructor.

Parameters

vxLicense The vx license.

Definition at line 8 of file License.cpp.

                                                  {
     _license = vxLicense;
 }

virtual CPPCli::License::~License ( )

inlinevirtual

Destructor.

Definition at line 43 of file License.h.

                            {
             this->!License();
         }

CPPCli::License::!License ( )

Finaliser.

Definition at line 12 of file License.cpp.

                         {
     _license->Delete();
     _license = nullptr;
 }

Member Function Documentation

List< CPPCli::LicenseFeature^ > CPPCli::License::_GetLicenseFeatures ( )

package

Definition at line 17 of file License.cpp.

                                                                 {
     // Create a list of managed license feature objects
     List<CPPCli::LicenseFeature^>^ mlist = gcnew List<CPPCli::LicenseFeature^>();
     // Create a collection of unmanaged license feature objects
     VxSdk::VxCollection<VxSdk::IVxLicenseFeature**> licenseFeatures;
 
     // Make the GetLicenseFeatures call, which will return with the total count of license features, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _license->GetLicenseFeatures(licenseFeatures);
     // Unless there are no license features on the system, this should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // An array of pointers is allocated using the size returned by the previous GetLicenseFeatures call
         licenseFeatures.collection = new VxSdk::IVxLicenseFeature*[licenseFeatures.collectionSize];
         result = _license->GetLicenseFeatures(licenseFeatures);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < licenseFeatures.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::LicenseFeature(licenseFeatures.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] licenseFeatures.collection;
     }
     return mlist;
 }

Member Data Documentation

VxSdk::IVxLicense* CPPCli::License::_license

package

Definition at line 80 of file License.h.

Property Documentation

System:: String^ CPPCli::License::CompanyName

get

Gets the friendly name of the owning company/organization.

The friendly name of the owning company/organization.

Definition at line 56 of file License.h.

System:: Collections:: Generic:: List< LicenseFeature^>^ CPPCli::License::LicenseFeatures

get

Gets the features this license contains.

A List of license features.

Definition at line 65 of file License.h.

SystemLicenseTypes CPPCli::License::SystemLicenseType

get

Gets the type of system that this license is applied to.

The system license Type.

Definition at line 74 of file License.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/License.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/License.cpp

Public Types

Public Member Functions

Package Functions