pycatia.knowledge_interfaces.language_sheet_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

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.knowledge_interfaces.language_sheet_setting_att.LanguageSheetSettingAtt(com_object)

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

LanguageSheetSettingAtt

The interface to access a CATIALanguageSheetSettingAtt.

get_knowledge_build_path_directory_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetKnowledgeBuildPathDirectoryInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the CATKnowledgeBuildPath setting

parameter.

Refer to SettingController for a detailed description.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

Return type

bool

get_list_of_packages_to_load_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetListOfPackagesToLoadInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ListOfPackagesToLoad setting

parameter.

Refer to SettingController for a detailed description.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

Return type

bool

get_load_all_packages_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetLoadAllPackagesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the LoadAllPackages setting

parameter.

Refer to SettingController for a detailed description.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

Return type

bool

get_load_extended_language_lib_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetLoadExtendedLanguageLibInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the LoadExtendedLanguageLib setting

parameter.

Refer to SettingController for a detailed description.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

Return type

bool

get_reference_directory_for_types_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetReferenceDirectoryForTypesInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves information about the ReferenceDirectoryForTypes setting

parameter.

Refer to SettingController for a detailed description.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

Return type

bool

property knowledge_build_path_directory

Note

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

o Property KnowledgeBuildPathDirectory() As CATBSTR

Returns or sets the CATKnowledgeBuildPath setting

parameter.

Role:Return or Set the CATKnowledgeBuildPath parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oKnowledgeBuildPathDirectory

The knowledge build path directory: the path where all the

resources are located.

Returns

str

Return type

str

property list_of_packages_to_load

Note

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

o Property ListOfPackagesToLoad() As CATBSTR

Returns or sets the ListOfPackagesToLoad parameter.

Role:Return or Set the ListOfPackagesToLoad parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oListOfPackagesToLoad

The list of packages to load.

Returns

str

Return type

str

property load_all_packages

Note

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

o Property LoadAllPackages() As short

Returns or sets the LoadAllPackages parameter.

Role:Return or Set the LoadAllPackages parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

oLoadAllPackages

Legal values:

0 : to not load all packages

1 : to load all packages.

Returns

int

Return type

int

property load_extended_language_lib

Note

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

o Property LoadExtendedLanguageLib() As short

Returns or sets the LoadExtendedLanguageLib parameter.

Role:Return or Set the LoadExtendedLanguageLib parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

oLoadExtendedLanguageLib

Legal values:

0 : to not use extended libraries

1 : to use extended libraries.

Returns

int

Return type

int

property reference_directory_for_types

Note

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

o Property ReferenceDirectoryForTypes() As CATBSTR

Returns or sets the ReferenceDirectoryForTypes parameter.

Role:Return or Set the ReferenceDirectoryForTypes parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

oReferenceDirectoryForTypes

The reference directory for types.

Returns

str

Return type

str

set_knowledge_build_path_directory_lock(i_locked: bool) → None

Note

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

o Sub SetKnowledgeBuildPathDirectoryLock(boolean iLocked)

Locks or unlocks the CATKnowledgeBuildPath setting

parameter.

Refer to SettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

Return type

None

set_list_of_packages_to_load_lock(i_locked: bool) → None

Note

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

o Sub SetListOfPackagesToLoadLock(boolean iLocked)

Locks or unlocks the ListOfPackagesToLoad setting

parameter.

Refer to SettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

Return type

None

set_load_all_packages_lock(i_locked: bool) → None

Note

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

o Sub SetLoadAllPackagesLock(boolean iLocked)

Locks or unlocks the LoadAllPackages setting parameter.

Refer to SettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

Return type

None

set_load_extended_language_lib_lock(i_locked: bool) → None

Note

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

o Sub SetLoadExtendedLanguageLibLock(boolean iLocked)

Locks or unlocks the LoadExtendedLanguageLib setting

parameter.

Refer to SettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

Return type

None

set_reference_directory_for_types_lock(i_locked: bool) → None

Note

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

o Sub SetReferenceDirectoryForTypesLock(boolean iLocked)

Locks or unlocks the ReferenceDirectoryForTypes setting

parameter.

Refer to SettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

Return type

None