pycatia.in_interfaces.macros_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.in_interfaces.macros_setting_att.MacrosSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

MacrosSettingAtt

Setting controller for the Macros tab page.

get_default_macro_libraries() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetDefaultMacroLibraries() As CATSafeArrayVariant

Returns the list of default macro libraries.

Return type:

tuple

get_default_macro_libraries_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_external_references() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetExternalReferences() As CATSafeArrayVariant

Returns the list of external references.

Return type:

tuple

get_external_references_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

get_language_editor(i_language: int) → str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetLanguageEditor(CATScriptLanguage iLanguage) As

CATBSTR

Returns the editor path for the specified language.

Parameters:

i_language (int) – enum cat_script_language

Return type:

str

get_language_editor_info(admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

• admin_level (str) –

• o_locked (str) –

Return type:

bool

set_default_macro_libraries(i_libraries: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetDefaultMacroLibraries(CATSafeArrayVariant

iLibraries)

Sets the list of default macro libraries.

Parameters:

i_libraries (tuple) –

Return type:

None

set_default_macro_libraries_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

i_locked (bool) –

Return type:

None

set_external_references(i_references: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetExternalReferences(CATSafeArrayVariant iReferences)

Sets the list of external references.

Parameters:

i_references (tuple) –

Return type:

None

set_external_references_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

i_locked (bool) –

Return type:

None

set_language_editor(i_language: int, i_editor_path: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetLanguageEditor(CATScriptLanguage iLanguage,

CATBSTR iEditorPath)

Sets the editor path for the specified language.

Parameters:

• i_language (int) – enum cat_script_language

• i_editor_path (str) –

Return type:

None

set_language_editor_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

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.

Parameters:

i_locked (bool) –

Return type:

None