CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
CFxLicenseInfo Class Referenceabstract

#include <FxLicenseInfo.h>

Public Types

enum  {
  Unknown_Version = 0 , Unregistered_Version = 1 , Trial_Version = 2 , Full_Version = 3 ,
  Floating_Version = 4 , Roaming_Version = 5 , Dongle_Version = 6 , LicenseToGo_Version = 7 ,
  Unregistered_Was_Network = 8 , Offline_Version = 9
}
 

Public Member Functions

 CFxLicenseInfo (void)
 
virtual ~CFxLicenseInfo (void)
 
virtual int CheckOutLicense ()=0
 
virtual int CheckInLicense ()=0
 
virtual bool IsLicenseCheckedOut () const =0
 
virtual bool IsTrialExpired () const =0
 
virtual bool IsLicenseHealthy () const =0
 
virtual bool IsNetworkConnectionLost () const =0
 
virtual int GetLicenseType () const =0
 
virtual bool IsFullVersion () const =0
 
virtual bool IsUnregisteredVersion () const =0
 
virtual bool IsTrialVersion () const =0
 
virtual int GetLicenseDays () const =0
 
virtual CFxString GetLicenseOptions () const =0
 
virtual CFxString GetHostID (bool bComputerHostID) const =0
 
virtual CFxString GetLicenseHostId () const =0
 
virtual int IsProductKeyValid (const CFxString &productKey) const =0
 
virtual int IsActivationCodeValid (const CFxString &sActivationCode) const =0
 
virtual int SaveActivationCode (const CFxString &sActivationCode)=0
 
virtual CFxString GetLicensePath () const =0
 
virtual int GetRoamingLicenseMaxDays () const =0
 
virtual int GetRoamingLicenseMaxShares () const =0
 
virtual int GetRoamingLicenseMaxCount () const =0
 
virtual int GetRoamingProductMaxCount () const =0
 
virtual int GetRoamingProductCurrentCount () const =0
 
virtual bool IsRoaming () const =0
 
virtual int GetError () const =0
 
virtual CFxString GetGde () const =0
 
virtual CFxString GetVersion () const =0
 
virtual bool IsPrerelease () const =0
 
virtual bool AllowsDongleActivation () const =0
 
virtual bool InAppleSandbox () const =0
 
virtual bool IsExtendedApiEnabled () const =0
 
virtual bool IsMFCUIEnabled () const =0
 
virtual bool IsLispEnabled () const =0
 
virtual void DisableLisp ()=0
 
virtual void EnableLisp ()=0
 
virtual bool IsFibersEnabled () const =0
 
virtual bool IsDWFEnabled () const =0
 
virtual void DisableDWF ()=0
 
virtual bool IsDWFSaveEnabled () const =0
 
virtual bool IsSHPEnabled () const =0
 
virtual void CleanUp ()=0
 
virtual bool ValidateDongle () const =0
 

Detailed Description

Description: Manages the license information. Library: DDKERNEL

Definition at line 32 of file FxLicenseInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Unknown_Version 
Unregistered_Version 
Trial_Version 
Full_Version 
Floating_Version 
Roaming_Version 
Dongle_Version 
LicenseToGo_Version 
Unregistered_Was_Network 
Offline_Version 

Definition at line 35 of file FxLicenseInfo.h.

Constructor & Destructor Documentation

◆ CFxLicenseInfo()

CFxLicenseInfo::CFxLicenseInfo ( void  )

◆ ~CFxLicenseInfo()

virtual CFxLicenseInfo::~CFxLicenseInfo ( void  )
virtual

Member Function Documentation

◆ AllowsDongleActivation()

virtual bool CFxLicenseInfo::AllowsDongleActivation ( ) const
pure virtual

Description: Returns true if dongle activation is allowed. Arguments: Return Value: Returns true if dongle activation is allowed.

◆ CheckInLicense()

virtual int CFxLicenseInfo::CheckInLicense ( )
pure virtual

Description: Checks in available license. Arguments: Return Value: Returns the error number or 0 in case of success.

◆ CheckOutLicense()

virtual int CFxLicenseInfo::CheckOutLicense ( )
pure virtual

Description: Checks out available license. Arguments: Return Value: Returns the error number or 0 in case of success.

◆ CleanUp()

virtual void CFxLicenseInfo::CleanUp ( )
pure virtual

Description: Cleans up the data. Arguments: Return Value:

◆ DisableDWF()

virtual void CFxLicenseInfo::DisableDWF ( )
pure virtual

Description: Disable DWF. Arguments: Return Value:

◆ DisableLisp()

virtual void CFxLicenseInfo::DisableLisp ( )
pure virtual

Description: Disables Lisp. Arguments: Return Value:

◆ EnableLisp()

virtual void CFxLicenseInfo::EnableLisp ( )
pure virtual

Description: Enables Lisp. Arguments: Return Value:

◆ GetError()

virtual int CFxLicenseInfo::GetError ( ) const
pure virtual

Description: Returns the last error occured. Arguments: Return Value: Returns the last error occured.

◆ GetGde()

virtual CFxString CFxLicenseInfo::GetGde ( ) const
pure virtual

Description: Returns the GDE number of the product. Arguments: Return Value: Returns the GDE number of the product.

◆ GetHostID()

virtual CFxString CFxLicenseInfo::GetHostID ( bool  bComputerHostID) const
pure virtual

Description: Generates a host ID based. Arguments:

Parameters
bComputerHostIDIf set to true the host ID is based on the computer else the host ID from the attached dongle will be returned. Return Value: Returns the host ID of the system or dongle else an empty string.

◆ GetLicenseDays()

virtual int CFxLicenseInfo::GetLicenseDays ( ) const
pure virtual

Description: Returns the number of license days remaining. Negative values indicate full version. Arguments: Return Value: Returns number of license days or -1 in case of full version.

◆ GetLicenseHostId()

virtual CFxString CFxLicenseInfo::GetLicenseHostId ( ) const
pure virtual

Description: Gets the host ID from License string. Arguments: Return Value: Returns the license host ID provided in the License string.

◆ GetLicenseOptions()

virtual CFxString CFxLicenseInfo::GetLicenseOptions ( ) const
pure virtual

Description: Returns the serial number details for display in about boxes. Arguments: Return Value: Returns serial number string for display.

◆ GetLicensePath()

virtual CFxString CFxLicenseInfo::GetLicensePath ( ) const
pure virtual

Description: Returns the license path for storing licenses. Arguments: Return Value: Returns the license path for storing licenses.

◆ GetLicenseType()

virtual int CFxLicenseInfo::GetLicenseType ( ) const
pure virtual

Description: Returns the type of license that is used. Arguments: Return Value: Returns Unknown_Version, Unregistered_Version, Trial_Version, Full_Version, Floating_Version, Roaming_Version, or Dongle_Version.

◆ GetRoamingLicenseMaxCount()

virtual int CFxLicenseInfo::GetRoamingLicenseMaxCount ( ) const
pure virtual

Description: Returns the maximal count of licenses can be roamed. Arguments: Return Value: Returns the maximal count of licenses can be roamed.

◆ GetRoamingLicenseMaxDays()

virtual int CFxLicenseInfo::GetRoamingLicenseMaxDays ( ) const
pure virtual

Description: Returns the maximal days a license can be roamed. Arguments: Return Value: Returns the maximal days a license can be roamed.

◆ GetRoamingLicenseMaxShares()

virtual int CFxLicenseInfo::GetRoamingLicenseMaxShares ( ) const
pure virtual

Description: Returns the maximal shares license can roam. Arguments: Return Value: Returns the maximal shares license can roam.

◆ GetRoamingProductCurrentCount()

virtual int CFxLicenseInfo::GetRoamingProductCurrentCount ( ) const
pure virtual

Description: Returns the current count of licenses can be roamed by the product. Arguments: Return Value: Returns the current count of licenses can be roamed by the product.

◆ GetRoamingProductMaxCount()

virtual int CFxLicenseInfo::GetRoamingProductMaxCount ( ) const
pure virtual

Description: Returns the maximal count of licenses can be roamed by the product. Arguments: Return Value: Returns the maximal count of licenses can be roamed by the product.

◆ GetVersion()

virtual CFxString CFxLicenseInfo::GetVersion ( ) const
pure virtual

Description: Returns the version number of the product. Arguments: Return Value: Returns the version number of the product.

◆ InAppleSandbox()

virtual bool CFxLicenseInfo::InAppleSandbox ( ) const
pure virtual

Description: Returns true if apple sandbox is enabled. Arguments: Return Value: Returns true if apple sandbox is enabled.

◆ IsActivationCodeValid()

virtual int CFxLicenseInfo::IsActivationCodeValid ( const CFxString &  sActivationCode) const
pure virtual

◆ IsDWFEnabled()

virtual bool CFxLicenseInfo::IsDWFEnabled ( ) const
pure virtual

Description: Returns true if DWF is enabled. Arguments: Return Value: Returns true if DWF is enabled.

◆ IsDWFSaveEnabled()

virtual bool CFxLicenseInfo::IsDWFSaveEnabled ( ) const
pure virtual

Description: Returns true if DWF saving is enabled. Arguments: Return Value: Returns true if DWF saving is enabled.

◆ IsExtendedApiEnabled()

virtual bool CFxLicenseInfo::IsExtendedApiEnabled ( ) const
pure virtual

Description: Returns true if extended API is enabled. Arguments: Return Value: Returns true if extended API is enabled.

◆ IsFibersEnabled()

virtual bool CFxLicenseInfo::IsFibersEnabled ( ) const
pure virtual

Description: Returns true if fibers is enabled. Arguments: Return Value: Returns true if fibers is enabled.

◆ IsFullVersion()

virtual bool CFxLicenseInfo::IsFullVersion ( ) const
pure virtual

Description: Returns true if the license type is Full_Version, Floating_Version, Roaming_Version or Dongle_Version. Arguments: Return Value: Returns true if the license type is Full_Version, Floating_Version, Roaming_Version or Dongle_Version.

◆ IsLicenseCheckedOut()

virtual bool CFxLicenseInfo::IsLicenseCheckedOut ( ) const
pure virtual

Description: Returns true if a license is checked out else false. Arguments: Return Value: Returns true if a license is checked out else false.

◆ IsLicenseHealthy()

virtual bool CFxLicenseInfo::IsLicenseHealthy ( ) const
pure virtual

Description: Returns true if the license is healthy else false. Arguments: Return Value: Returns true if the license is healthy else false.

◆ IsLispEnabled()

virtual bool CFxLicenseInfo::IsLispEnabled ( ) const
pure virtual

Description: Returns true if Lisp is enabled. Arguments: Return Value: Returns true if Lisp is enabled.

◆ IsMFCUIEnabled()

virtual bool CFxLicenseInfo::IsMFCUIEnabled ( ) const
pure virtual

Description: Returns true if MFC UI is enabled. Arguments: Return Value: Returns true if MFC UI is enabled.

◆ IsNetworkConnectionLost()

virtual bool CFxLicenseInfo::IsNetworkConnectionLost ( ) const
pure virtual

Description: Returns true if the network connection is lost else false. Arguments: Return Value: Returns true if the network connection is lost else false.

◆ IsPrerelease()

virtual bool CFxLicenseInfo::IsPrerelease ( ) const
pure virtual

Description: Returns true if the version is branded as pre-release or developer preview. Arguments: Return Value: Returns true if the version is branded as pre-release or developer preview.

◆ IsProductKeyValid()

virtual int CFxLicenseInfo::IsProductKeyValid ( const CFxString &  productKey) const
pure virtual

Description: Verifies the product key. Arguments:

Parameters
sProductKeyThe product key to check. Return Value: Returns the error code.

◆ IsRoaming()

virtual bool CFxLicenseInfo::IsRoaming ( ) const
pure virtual

Description: Returns true if the license is roaming currently. Arguments: Return Value: Returns true if the license is roaming currently.

◆ IsSHPEnabled()

virtual bool CFxLicenseInfo::IsSHPEnabled ( ) const
pure virtual

Description: Returns true if SHP is enabled. Arguments: Return Value: Returns true if SHP is enabled.

◆ IsTrialExpired()

virtual bool CFxLicenseInfo::IsTrialExpired ( ) const
pure virtual

Description: Returns true if the trial license is expired else false. Arguments: Return Value: Returns true if the trial license is expired else false.

◆ IsTrialVersion()

virtual bool CFxLicenseInfo::IsTrialVersion ( ) const
pure virtual

Description: Returns true if the license type is Trial_Version. Arguments: Return Value: Returns true if the license type is Trial_Version.

◆ IsUnregisteredVersion()

virtual bool CFxLicenseInfo::IsUnregisteredVersion ( ) const
pure virtual

Description: Returns true if the license type is Unknown_Version or Unregistered_Version. Arguments: Return Value: Returns true if the license type is Unknown_Version or Unregistered_Version.

◆ SaveActivationCode()

virtual int CFxLicenseInfo::SaveActivationCode ( const CFxString &  sActivationCode)
pure virtual

Description: Verifies and saves the activation code. Arguments:

Parameters
sActivationCodeThe activation code to check and save. Return Value: Returns the error code.

◆ ValidateDongle()

virtual bool CFxLicenseInfo::ValidateDongle ( ) const
pure virtual

Description: Returns true if no dongle is required or the dongle is read successfully. Arguments: Return Value: Returns true if no dongle is required or the dongle is read successfully.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:10:33