All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysDynLicenseSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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, no information is written in the settings, only the lock status is written in the settings.


    Method Index


    o GetLicense(CATUnicodeString*,CATUnicodeString*)
    The method is not relevant for the settings.
    o GetLicenseInfo(CATUnicodeString*,CATSettingInfo*)
    Retrieves information about the License setting parameter.
    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 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 HRESULT GetLicense( const CATUnicodeString* iLicense,
    CATUnicodeString* oValue)=0
    The method is not relevant for the settings.
    Role: The method is not relevant for the settings, because a dynamic license is only taken in account for the current session. The output oValue will always be "".
    Parameters:
    iLicense
    the name of the license .
    oValue
    the value of the License.
    ""
    Returns:
    Legal values:
    S_OK : on success
    E_FAIL: on failure
    o GetLicenseInfo
    public virtual HRESULT GetLicenseInfo( const CATUnicodeString* iLicense,
    CATSettingInfo* oInfo)=0
    Retrieves information about the License setting parameter.
    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.
    Parameters:
    iLicense:
    the name of the License.
    oInfo:
    Address of an object CATSettingInfo.
    Returns:
    Legal values:
    E_FAIL
    Refer to CATSysSettingController 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, because the status od the license is not modified, only the lock status is modified.
  • o GetLicensesList
    public virtual HRESULT GetLicensesList(int& NbLic,
    CATUnicodeString**& oTabLic) =0
    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.
    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 HRESULT GetLicensesListInfo(CATSettingInfo* oInfo)=0
    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
    CATSysSettingController for a detailed description.
    o SetLicenseLock
    public virtual HRESULT SetLicenseLock( const CATUnicodeString* iLicense,
    unsigned char iLock)=0
    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 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 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 CATSysSettingController for a detailed description.

    This object is included in the file: CATISysDynLicenseSettingAtt.h
    If needed, your Imakefile.mk should include the module: JS0GROUP

    Copyright © 2003, Dassault Systèmes. All rights reserved.