System Interface CATISysDynLicenseSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATISysDynLicenseSettingAtt

Interface to handle the dynamic licensing settings.
Role: This interface is implemented by a component which represents the controller of the dynamic Licenses.
To access this property page:

  • Click the Options command in the Tools menu
  • Click General
  • Click the Shareable Products Property Page

    • This interface defines:
  • A method to lock/unlock each parameter
  • A method to retrieve the information concerning each parameter
  • Note that when a license is selected in user mode, no information is written in the settings, only the lock status is written in the settings.

    Method Index


    o GetLicense(CATUnicodeString*,CATUnicodeString*)
    Retrieves the check_lock value of the license.
    o GetLicenseInfo(CATUnicodeString*,CATSettingInfo*)
    Retrieves the state of a given License.
    o GetLicensesList(int&,CATUnicodeString**&)
    Retrieves the List of the Licenses.
    o GetLicensesListInfo(CATSettingInfo*)
    Retrieves information about the LicensesList setting locking state (global lock for the LicensesList).
    o SetLicense(CATUnicodeString*,CATUnicodeString*)
    Sets the check_lock status of license.
    o SetLicenseLock(CATUnicodeString*,unsigned char)
    Locks or unlocks the License setting parameter.
    o SetLicensesListLock(unsigned char)
    Locks or unlocks the LicensesList setting parameter.

    Methods


    o GetLicense
    public virtual GetLicense( const iLicense,
    oValue)
    Retrieves the check_lock value of the license.
    Role: Retrieves the mapping between a name of a license and the check_lock value of the license. Note: This method appears after a dump action by default in the generated macro when administrator parameters are locked. It does not return a granted or not granted status on the license. When the license is not checklocked GetLicense() does not appears in the dump, even when GetLicenseInfo() appears. Use this call to get the check_lock status of a license. There is no inheritance of the check_lock status of a license for the end user: If the check_lock has been requested for any of the administrator, the license appears locked for the end user, In user mode the license ZZZ.prd appears locked in the shareable product tab when parameter iLicense="Check_ZZZ.prd", and the parameter oValue="CheckLockRequested". The value "CheckNotLockRequested" appears only when the setting exits (a license check button has been first unchecked, validated with OK button, and then the license check button has been rechecked).
  • There is no link between the lock on the license itself which is used when there are several admin levels. For iLicense="ZZZ.prd", the oValue may be "Locked" or "Unlocked".
  • For a package: iLicense="Check_Mypackage.package" and oValue="CheckLockRequested". (Mypackage is the name of the package).
    • Parameters:
    iLicense
    The license name begins with Check_ for checklocks
    oValue
    the value of the License:
    CheckLockRequested : check_lock requested.
    CheckLockNotRequested : check_lock not requested.
    "": always if the licenses are not checklock. In that case the license value is not modified. It is the lock status whom cares.
    Returns:
    Legal values:
    S_OK : on success
    E_FAIL: on failure
    o GetLicenseInfo
    public virtual GetLicenseInfo( const iLicense,
    oInfo)
    Retrieves the state of a given License.
    Role: Retrieves the state of a given License. It it is used to get the lock status of a specific license. When the license is locked, it means that an administrator has locked the attribute. It does not means that an administrator has changed the value of the license. The return value is true when the license is checklocked, because the value of the license is Check_XXX.prd
    Parameters:
    iLicense:
    the name of the License.
    oInfo:
    Address of an object CATSettingInfo.
    Returns:
    Legal values:
    E_FAIL:
    Refer to for a detailed description.
    Dump information:
  • Parameter 1 : the name of the License.
  • Parameter 2 : "Set at Admin Level j" when locked, "Default value" when unlock.
  • Parameter 3 : locking state of the licenses Unlocked / Locked / Locked at Admin Level j.
  • Return value : Always false if the license is not checklock, because the status of the license is not modified, only the lock status is modified. True if the license is checklock, because the value of the license has been changed to Check_XXX.prd.
    • o GetLicensesList
    public virtual GetLicensesList( NbLic,
    oTabLic)
    Retrieves the List of the Licenses.
    Role: Retrieves the list of the locked Licenses. There is no SetLicenseList() because the list is initialized using LUM.
  • When using packages, the licenses name appears like MyPackage.Package (Mypackage is the name of the package).
    • Parameters:
    oNbLic
    The number of Licenses
    oTabLic
    The array of Licenses
    Returns:
    Legal values:
    S_OK : on success
    E_FAIL: on failure
    o GetLicensesListInfo
    public virtual GetLicensesListInfo( oInfo)
    Retrieves information about the LicensesList setting locking state (global lock for the LicensesList).
    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 LicenseList 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.
    Parameter values in 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
    for a detailed description.
    o SetLicense
    public virtual SetLicense( const iLicense,
    const iValue)
    Sets the check_lock status of license.
    Role: Sets the check_lock value of the license. It it not possible to grant a license with this call. This method shoud be called in administrator mode. There is no inheritance of the check_lock status of a license for the end user: If the check_lock has been requested for any of the administrator, the license appears locked for the end user, In user mode the license ZZZ.prd appears locked in the shareable product tab when parameter iLicense="Check_ZZZ.prd", and the parameter iValue="CheckLockRequested". The value "CheckNotLockRequested" appears only when the setting exits (a license check button has been first unchecked, validated with OK button, and then the license check button has been rechecked).
  • There is no link between the lock on the license itself which is used when there are several admin levels. For iLicense="ZZZ.prd", the iValue may be "Locked" or "Unlocked".
  • For a package: iLicense="Check_Mypackage.package" and iValue="CheckLockRequested". (Mypackage is the name of the package).
    • Parameters:
    iLicense
    The license name begins with Check_
    iValue
    the value of the License:
    CheckLockRequested : check_lock requested.
    CheckLockNotRequested : check_lock not requested.
    Returns:
    Legal values:
    S_OK : on success
    E_FAIL: on failure
    o SetLicenseLock
    public virtual SetLicenseLock( const iLicense,
    iLock)
    Locks or unlocks the License setting parameter.
    Role: Locks or unlocks the given License if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
    Parameters:
    iLicense:
    the name of the License.
    iLock
    the locking operation to be performed:
    1 : to lock the parameter.
    0: to unlock the parameter.
    Returns:
    Legal values:
    S_OK : on success
    E_FAIL: on failure
    Refer to for a detailed description.
    o SetLicensesListLock
    public virtual SetLicensesListLock( iLock)
    Locks or unlocks the LicensesList setting parameter.
    Role: Locks or unlocks the parameter describing the list of installed licenses, if the operation is allowed in the current administrated environment. 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.
    Returns:
    Legal values:
    S_OK : on success (the list has been successfully lock or unlocked).
    E_OUTOFMEMORY: on allocation failure
    E_FAIL: on other failures
    Refer to for a detailed description.
    This object is included in the file: CATISysDynLicenseSettingAtt.h
    If needed, your Imakefile.mk should include the module: JS0GROUP

    Copyright © 1999-2015, Dassault Systèmes. All rights reserved.