All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

MacrosSettingAtt (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---SettingController
            |
            +---MacrosSettingAtt
 


Setting controller for the Macros tab page.

Method Index

GetDefaultMacroLibraries
Returns the list of default macro libraries.
GetDefaultMacroLibrariesInfo
Retrieves environment informations for the default macro libraries setting.
GetExternalReferences
Returns the list of external references.
GetExternalReferencesInfo
Retrieves environment informations for the external references setting.
GetLanguageEditor
Returns the editor path for the specified language.
GetLanguageEditorInfo
Retrieves environment informations for the language editors setting.
SetDefaultMacroLibraries
Sets the list of default macro libraries.
SetDefaultMacroLibrariesLock
Locks or unlocks the default macro libraries setting.
SetExternalReferences
Sets the list of external references.
SetExternalReferencesLock
Locks or unlocks the external references setting.
SetLanguageEditor
Sets the editor path for the specified language.
SetLanguageEditorLock
Locks or unlocks the language editors setting.

Methods


o Func GetDefaultMacroLibraries() As CATSafeArrayVariant
Returns the list of default macro libraries.
o Func GetDefaultMacroLibrariesInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean
Retrieves environment informations for the default macro libraries setting.
Role:Retrieves the state of the parameter default macro libraries setting in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetExternalReferences() As CATSafeArrayVariant
Returns the list of external references.
o Func GetExternalReferencesInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean
Retrieves environment informations for the external references setting.
Role:Retrieves the state of the parameter external references setting in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetLanguageEditor(CATScriptLanguage iLanguage) As CATBSTR
Returns the editor path for the specified language.
o Func GetLanguageEditorInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean
Retrieves environment informations for the language editors setting.
Role:Retrieves the state of the parameter language editors setting in the current environment.
Parameters:
AdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub SetDefaultMacroLibraries(CATSafeArrayVariant iLibraries)
Sets the list of default macro libraries.
o Sub SetDefaultMacroLibrariesLock(boolean iLocked)
Locks or unlocks the default macro libraries setting.
Role:Locks or unlocks the default macro libraries setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
True : to lock the parameter.
False: to unlock the parameter.
o Sub SetExternalReferences(CATSafeArrayVariant iReferences)
Sets the list of external references.
o Sub SetExternalReferencesLock(boolean iLocked)
Locks or unlocks the external references setting.
Role:Locks or unlocks the external references setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
True : to lock the parameter.
False: to unlock the parameter.
o Sub SetLanguageEditor(CATScriptLanguage iLanguage,
CATBSTR iEditorPath)
Sets the editor path for the specified language.
o Sub SetLanguageEditorLock(boolean iLocked)
Locks or unlocks the language editors setting.
Role:Locks or unlocks the language editors setting if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
True : to lock the parameter.
False: to unlock the parameter.

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