PLCnext API Documentation  20.0.0.24462
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Lm::Services::ILicenseStatusService Class Referenceabstract

Service methods retrieving current license status More...

#include <ILicenseStatusService.hpp>

Inheritance diagram for Arp::System::Lm::Services::ILicenseStatusService:
Inheritance graph

Public Types

typedef std::shared_ptr< ILicenseStatusServicePtr
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 ILicenseStatusService (void)
 Constructs an ILicenseStatusService instance. More...
 
virtual ~ILicenseStatusService (void)
 Destructs this instance and frees all resouces. More...
 
virtual boolean GetLicenseStatus (uint32 firmCode, uint32 productCode, uint32 featureCode=0)=0
 Retrieves license status of specified firm code, product code and feature code provide by license issuer More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

Service methods retrieving current license status

Constructor & Destructor Documentation

◆ ILicenseStatusService()

Arp::System::Lm::Services::ILicenseStatusService::ILicenseStatusService ( void  )
inline

Constructs an ILicenseStatusService instance.

◆ ~ILicenseStatusService()

Arp::System::Lm::Services::ILicenseStatusService::~ILicenseStatusService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ GetLicenseStatus()

virtual boolean Arp::System::Lm::Services::ILicenseStatusService::GetLicenseStatus ( uint32  firmCode,
uint32  productCode,
uint32  featureCode = 0 
)
pure virtual

Retrieves license status of specified firm code, product code and feature code provide by license issuer

Parameters
firmCodeFirm code
productCodeProduct code
featureCodeFeature code (ignored if 0)
Returns
true, if license is valid, false if license is invalid
Exceptions
System.InvalidOperationException"License manager has not been configured."

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