pycatia.system_interfaces.dl_name_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-09 09:53:18.676780

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.system_interfaces.dl_name_setting_att.DlNameSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

DLNameSettingAtt

Interface to handle the DLNames.

Role: This interface is implemented by a component which represents the

controller of the DLNames.

This interface defines:

A method to set each DLName

A method to get the value of each DLName

A method to lock/unlock each parameter

A method to retrieve the informations concerning each

parameter

property dl_name_creation_right¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780): o Property DLNameCreationRight() As boolean

Returns or set the right to create new DLNames.

Role: Retrieves or set the right to create new DLNames.

Returns:: bool

get_dl_name(i_dl_name, o_real_name_unix, o_real_name_nt, o_father)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub GetDLName(CATBSTR iDLName,

CATBSTR oRealNameUnix,

CATBSTR oRealNameNT,

CATBSTR oFather)

Retrieves the mapping between a logical name and the physical

path.

Role: Retrieves the mapping between a logical name and the physical

path.

Parameters:

iDLName

the logical name.

oRealNameUnix

the real physical path corresponding to the logical name on Unix.

oRealNameNT

the real physical path corresponding to the logical name on

Windows.

iFather

if applicable the Name of the parent DLName

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dl_name (str) –
o_real_name_unix (str) –
o_real_name_nt (str) –
o_father (str) –

Returns:

None

get_dl_name_creation_right_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Func GetDLNameCreationRightInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves the state of the parameter DLNameCreationRight.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Returns:

None

get_dl_name_exp(i_dl_name, o_real_name_unix, o_real_name_nt, o_father)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub GetDLNameExp(CATBSTR iDLName,

CATBSTR oRealNameUnix,

CATBSTR oRealNameNT,

CATBSTR oFather)

Retrieves the mapping between a logical name and the physical

path.

Role: Retrieves the mapping between a logical name and the physical path in

a literal form.

Parameters:

iDLName

the logical name.

oRealNameUnix

the real physical path corresponding to the logical name on Unix.

oRealNameNT

the real physical path corresponding to the logical name on

Windows.

iFather

if applicable the Name of the parent DLName

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dl_name (str) –
o_real_name_unix (str) –
o_real_name_nt (str) –
o_father (str) –

Returns:

None

get_dl_name_info(i_dl_name, admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Func GetDLNameInfo(CATBSTR iDLName,

CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves the state of the for a given DLName.

Role: This information defines the state of the setting parameter and is

made up of:

The administration level that sets the current value or the value used

to reset it

The administration level that has locked the setting

parameter.

A flag to indicate whether the setting parameter was

modified.

Parameters:

iDLName

a DLname.

ioAdminLevel

[inout] The administration leve that defines the value used when

resetting the setting parameter.

Legal values:

Default value if the DLName has never been defined in the

administration concatenation.

Admin Level n if the setting parameter has been

administered,

where n is an integer starting from 0 representing the rank of

the administration level.

ioLocked

[inout] A character string to indicate whether the parameter is

locked and the level of administration where the locking has been

proceeded.

Legal values:

Locked at Admin Level n if the setting parameter is locked by

then administration level n,

where n is an integer starting from 0.

Upper Locked if the setting parameter is locked by the current

administration level

Unlocked if the setting parameter is not

locked

Returns:

True to indicate that the DLName value has been defined at the current

administrator or user level. This is only possible with unlocked DLNames. False

means that the DLName is inherited from the

administration.

Parameters:

i_dl_name (str) –
admin_level (str) –
o_locked (str) –

Returns:

None

get_dl_name_list()¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Func GetDLNameList() As CATSafeArrayVariant

Retrieves the list of the DLNames.

Role: Retrieves the list of the defined DLNames.

Parameters:

oTabDLName

a CATSafeArrayVariant of CATBSTR of nb elements.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:: tuple

get_dl_name_sub_list(i_dl_name)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Func GetDLNameSubList(CATBSTR iDLName) As

CATSafeArrayVariant

Retrieves the list of the Sub-DLNames.

Role: Retrieves the list of the DLNames created in a given

DLName.

Parameters:

iDLName

The Father DLName. if iDLName=NULL all DLNames created at the root

level are return.

oNbDLname

The number of defined DLNames.

oTabDLName

The array of DLNames

Returns:

Legal values:

S_OK : on Success

E_OUTOFMEMORY: on allocation failure

E_FAIL: on other failures

Parameters:: i_dl_name (str) –
Returns:: tuple

get_root_dl_name_creation_right_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Func GetRootDLNameCreationRightInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves the state of the parameter

RootDLNameCreationRight.

Refer to SettingController for a detailed description.

Parameters:

admin_level (str) –
o_locked (str) –

Returns:

None

remove_dl_name(i_dl_name)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub RemoveDLName(CATBSTR iDLName)

Remove a logical name.

Role: Remove a DLName in the current set if it is

possible.

Parameters:

iDLName

the logical name.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:: i_dl_name (str) –
Returns:: None

rename_dl_name(i_dl_name, i_new_name)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub RenameDLName(CATBSTR iDLName,

CATBSTR iNewName)

Rename an existing DLName.

Role: Rename a DLName in the current set if it is

possible.

Parameters:

iDLName

the logical name to rename.

iNewName

the new logical name.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dl_name (str) –
i_new_name (str) –

Returns:

None

property root_dl_name_creation_right¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780): o Property RootDLNameCreationRight() As boolean

Returns or set the right to create new Root DLNames.

Role: Retrieves or set the right to create new Root DLNames.

Returns:: bool

set_dl_name(i_dl_name, i_real_name_unix, i_real_name_nt, i_father, i_verif_directory)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub SetDLName(CATBSTR iDLName,

CATBSTR iRealNameUnix,

CATBSTR iRealNameNT,

CATBSTR iFather,

boolean iVerifDirectory)

Sets the mapping between a logical name and the physical

path.

Role: Sets the value of the cache maximum size in Mo

Parameters:

iDLName

the logical name.

oRealNameUnix

the real physical path corresponding to the logical name on Unix.

oRealNameNT

the real physical path corresponding to the logical name on

Windows.

iFather

if applicable the Name of the parent DLName

iVerifDirectory

if VerifDirectory is set the existence of the directory on the

current platform will be check.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dl_name (str) –
i_real_name_unix (str) –
i_real_name_nt (str) –
i_father (str) –
i_verif_directory (bool) –

Returns:

None

set_dl_name_creation_right_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub SetDLNameCreationRightLock(boolean iLocked)

Locks or unlocks the parameter DLNameCreationRight.

Refer to SettingController for a detailed description.

Parameters:: i_locked (bool) –
Returns:: None

set_dl_name_lock(i_dl_name, i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub SetDLNameLock(CATBSTR iDLName,

boolean iLocked)

Locks or unlocks the DLName.

Role: Locks or unlocks the given DLName if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iDLname

the DLname to be locked.

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dl_name (str) –
i_locked (bool) –

Returns:

None

set_root_dl_name_creation_right_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)): o Sub SetRootDLNameCreationRightLock(boolean iLocked)

Locks or unlocks the parameter RootDLNameCreationRight.

Refer to SettingController for a detailed description.

Parameters:: i_locked (bool) –
Returns:: None

pycatia.system_interfaces.dl_name_setting_att¶

Navigation

Related Topics