All Frameworks Class Hierarchy This Framework Previous Next Indexes
System Interface CATISysLicenseSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISysLicenseSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISysLicenseSettingAtt
Interface to handle the licensing settings.
Role: This interface is implemented by a component which
represents the controller of the static Licenses.
To access this property page:
Click the Options command in the Tools menu
Click General
Click the Licensing Property Page
This interface defines:
A method to set each License
A method to get the value of each License
A method to lock/unlock each parameter
A method to retrieve the information concerning each parameter
Method Index
- o
GetDemoMode(unsigned char&)
- Retrieves the information on Demo Mode .
- o
GetDemoModeInfo(CATSettingInfo*)
- Retrieves information about the DemoMode setting parameter.
- o
GetFrequency(float&)
- Retrieves the server contact frequency .
- o
GetFrequencyInfo(CATSettingInfo*)
- Retrieves information about the Frequency setting parameter.
- o
GetGrantedLicensesList(int&,long,CATUnicodeString**&)
-
- o
GetLicense(CATUnicodeString*,CATUnicodeString*)
- Retrieves the value of the license.
- o
GetLicenseInfo(CATUnicodeString*,CATSettingInfo*)
- Retrieves information about the License setting parameter.
- o
GetLicensesList(int&,long,CATUnicodeString**&)
- Retrieves the List of the requested or locked Licenses .
- o
GetLicensesListInfo(CATSettingInfo*)
- Retrieves information about the LicensesList setting parameter.
- o
GetNodelockAlert(long&)
- Retrieves nodelock expiry alert .
- o
GetNodelockAlertInfo(CATSettingInfo*)
- Retrieves information about the nodelock expiry alert setting parameter.
- o
GetServerTimeOut(float&)
- Retrieves server time out .
- o
GetServerTimeOutInfo(CATSettingInfo*)
- Retrieves information about the TimeOut setting parameter.
- o
GetShowLicense(unsigned char&)
- Retrieves if licenses have to be shown .
- o
GetShowLicenseInfo(CATSettingInfo*)
- Retrieves information about the ShowLicense setting parameter.
- o
SetDemoMode(unsigned char)
- Sets the value of the parameter Demo Mode.
- o
SetDemoModeLock(unsigned char)
- Locks or unlocks the DemoMode setting parameter.
- o
SetFrequency(float)
- Sets the server contact frequency.
- o
SetFrequencyLock(unsigned char)
- Locks or unlocks the Frequency setting parameter.
- o
SetLicense(CATUnicodeString*,CATUnicodeString*)
- Sets the License.
- o
SetLicenseLock(CATUnicodeString*,unsigned char)
- Locks or unlocks the License setting parameter.
- o
SetLicensesListLock(unsigned char)
- Locks or unlocks the LicensesList setting parameter.
- o
SetNodelockAlert(long)
- Sets nodelock expiry alert .
- o
SetNodelockAlertLock(unsigned char)
- Locks or unlocks the nodelock expiry alert setting parameter.
- o
SetServerTimeOut(float)
- Sets server time out .
- o
SetServerTimeOutLock(unsigned char)
- Locks or unlocks the TimeOut setting parameter.
- o
SetShowLicense(unsigned char)
- Sets the value of the parameter ShowLicense.
- o
SetShowLicenseLock(unsigned char)
- Locks or unlocks the ShowLicense setting parameter.
Methods
o GetDemoMode
public virtual HRESULT GetDemoMode( | unsigned char& | oRight)=0 |
-
Retrieves the information on Demo Mode .
Role: Retrieves the value of the parameter describing if Demo Mode
is active.
- Parameters:
-
- oRight
- TRUE if the demo mode is active.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetDemoModeInfo
-
Retrieves information about the DemoMode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetFrequency
public virtual HRESULT GetFrequency( | float& | oFrequency)=0 |
-
Retrieves the server contact frequency .
Role: Retrieves the value of the parameter describing the
licensing server contact frequency in minutes. Note that a null value represents the maximum
contact frequency value.For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- oFrequency
- Licensing server contact frequency.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetFrequencyInfo
-
Retrieves information about the Frequency setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetGrantedLicensesList
-
- Deprecated:
- V5R15 CATSysLicenseSettingAtt#GetLicensesList
o GetLicense
-
Retrieves the value of the license.
Role: Retrieves the mapping between a name of a license and
the value of the license.
The license does not need to be returned by GetLicensesList().
- Parameters:
-
- iLicense
- the name of the license: "PMG.prd", "_MD2.slt+", "_MD2.slt+GSD" for example.
"PMG.prd" represent the license of the product PMG
"_MD2.slt+" represent the license of the solution MD2
"_MD2.slt+GSD"represent the license of the solution MD2, with the AddOn product GSD
- oValue
- the value of the License:
NotRequested : License is not Requested
key : the name of the license, the default available license has been chosen by the user. License is Requested.
License Number : a specific license number has been chosen by the user. License is Requested.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure. A problem occured during setting file access.
o GetLicenseInfo
-
Retrieves information about the License setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetLicensesList
-
Retrieves the List of the requested or locked Licenses .
Role: Retrieves the list of the Licenses.
- Parameters:
-
- oNbLic
- The number of License
- iDefaultLicenses
- If iDefaultLicenses!=0 and the settings are empty, returns the default licenses,
that is, the visible nodolocked licenses
If iDefaultLicenses == 0 and the settings are empty, returns the selected licenses
(not yet stored, because not yet validated by OK button).
- oTabLic
- The array of Licenses.
You are responsible of the deallocation of oTabLic:
if (oTabLic)
{
for (int Index = 0; Index < oNbLic; Index++)
delete oTabLic[Index];
delete [] oTabLic;
oTabLic = NULL;
}
character meaning in license name:
"_": internal notation for a license configuration
"+": you chose "Any license" mode, example of returned value: _ME1.slt+FS1
When the return value is a serial number (_ME1.slt_SerialNumber), you have chosen the "Explicit" license mode. In this case the add on product is not indicated in the license name.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetLicensesListInfo
-
Retrieves information about the LicensesList setting parameter.
Role: Retrieves information about the LicensesList setting locking state (global lock for the LicensesList).
It is used to get the lock status of the List of the Licenses.
If the LicensesList is locked all the licenses are locked.
When the licenses are locked, it means that an administrator has locked the attribute.
It does not means that an administrator has changed the value of the attribute.
The value of the setting is not updatable because it refers to a lock on a list.
That is why the return value is false.
- Parameters:
-
- oInfo:
- Address of an object CATSettingInfo.
Information returned in the dump:
- Parameter 1 : "Value taken in case of reset" : useless. Default value : "Default value"
- Parameter 2 : "Locking state" value : unlocked / locked / locked at Admin Level n
- Parameter 3 : "Returned value" : useless, default value : False
Refer to
CATSysSettingController for a detailed description.
o GetNodelockAlert
public virtual HRESULT GetNodelockAlert( | long& | oAlert)=0 |
-
Retrieves nodelock expiry alert .
Role: Retrieves the value of the parameter describing the
nodelock expiry alert in day. For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- oAlert
- Licensing server time out.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetNodelockAlertInfo
-
Retrieves information about the nodelock expiry alert setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetServerTimeOut
public virtual HRESULT GetServerTimeOut( | float& | oTimeOut)=0 |
-
Retrieves server time out .
Role: Retrieves the value of the parameter describing the
licensing server time out in minutes. For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- oTimeOut
- Licensing server time out.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetServerTimeOutInfo
-
Retrieves information about the TimeOut setting parameter.
Refer to
CATSysSettingController for a detailed description.
o GetShowLicense
public virtual HRESULT GetShowLicense( | unsigned char& | oRight)=0 |
-
Retrieves if licenses have to be shown .
Role: Retrieves the value of the parameter describing if complete
license information has to be shown.
When the parameter is set, the user gets more information about the reason of the failure to request a license.
- Parameters:
-
- oRight
- TRUE if the information has to be shown.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o GetShowLicenseInfo
-
Retrieves information about the ShowLicense setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetDemoMode
public virtual HRESULT SetDemoMode( | unsigned char | iRight)=0 |
-
Sets the value of the parameter Demo Mode.
Role: Sets the value of the parameter that discribing if Demo Mode
is active.
- Parameters:
-
- iRight
- TRUE if demo mode is active.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetDemoModeLock
public virtual HRESULT SetDemoModeLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the DemoMode setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetFrequency
public virtual HRESULT SetFrequency( | float | iFrequency)=0 |
-
Sets the server contact frequency.
Role: Sets the value of the parameter describing the
licensing server contact frequency in minutes. Note that a null value represents the maximum
contact frequency value. For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- iFrequency
- Licensing server contact frequency.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetFrequencyLock
public virtual HRESULT SetFrequencyLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the Frequency setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetLicense
-
Sets the License.
Role: Sets the value of the license.
- Parameters:
-
- iLicense
- the name of the license: "PMG.prd", "_MD2.slt+", "_MD2.slt+GSD" for example.
"PMG.prd" represent the license of the product PMG.
"_MD2.slt+" represent the license of the solution MD2.
"_MD2.slt+GSD" represent the license of the solution MD2, with the AddOn product GSD.
- iValue
- the value of the License:
NotRequested : License is not Requested
key : the name of the license, the default available license has been chosen by the user. License is Requested.
License Number : a specific license number has been chosen by the user. License is Requested.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetLicenseLock
-
Locks or unlocks the License setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetLicensesListLock
public virtual HRESULT SetLicensesListLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the LicensesList setting parameter.
Role:Locks or unlocks the LicensesList setting parameter.
Locks or unlocks the parameter describing the list of
installed licenses, if the operation is allowed in the current
administrated environment.
It is the global lock on all the licenses.
In user mode this method will always return E_FAIL.
When the LicenseList is locked all the licenses are locked.
When the LicenseList is unlocked all the licenses are unlocked.
- Parameters:
-
- iLock
- the locking operation to be performed:
1 : to lock the parameter.
0: to unlock the parameter.
Refer to
CATSysSettingController for a detailed description.
o SetNodelockAlert
public virtual HRESULT SetNodelockAlert( | long | iAlert)=0 |
-
Sets nodelock expiry alert .
Role: Sets the value of the parameter describing the
nodelock expiry alert in days. For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- iAlert
- Nodelock expiry alert.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetNodelockAlertLock
public virtual HRESULT SetNodelockAlertLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the nodelock expiry alert setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetServerTimeOut
public virtual HRESULT SetServerTimeOut( | float | iTimeOut)=0 |
-
Sets server time out .
Role: Sets the value of the parameter describing the
licensing server time out in minutes. For more information about the range and maximum, refers to the
Infrastructure documentation.
- Parameters:
-
- iTimeOut
- Licensing server time out.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetServerTimeOutLock
public virtual HRESULT SetServerTimeOutLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the TimeOut setting parameter.
Refer to
CATSysSettingController for a detailed description.
o SetShowLicense
public virtual HRESULT SetShowLicense( | unsigned char | iRight)=0 |
-
Sets the value of the parameter ShowLicense.
Role: Sets the value of the parameter that discribing if complete
license information has to be shown.
When the parameter is set, the user gets more information about the reason of the failure to request a license.
- Parameters:
-
- iRight
- TRUE if the information has to be shown.
- Returns:
- Legal values:
S_OK : on success
E_FAIL: on failure
o SetShowLicenseLock
public virtual HRESULT SetShowLicenseLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the ShowLicense setting parameter.
Refer to
CATSysSettingController for a detailed description.
This object is included in the file: CATISysLicenseSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP