pycatia.in_interfaces.printers_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.printers_setting_att.PrintersSettingAtt(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
PrintersSettingAtt

Represents a setting controller for the printer settings.
Role: This interface is implemented by a component which represents the
controller of the printer settings.
add_printer_directory(i_printer_dir: str, i_printer_dir_state: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddPrinterDirectory(CATBSTR iPrinterDir,
CatPrinterDirState iPrinterDirState)

Add a printer file directory to printer directories list and define its
state.

Parameters:

iPrinterDir
directory where some 3DPLM printers are defined.
The printers defined in this directory will be available for each
user.
iPrinterDirState
printer directory state.
Each directory can be protected to prevent user access to the
printers it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each
printer included in the directory cannot be
changed.
If the state is CatPrinterDirFree, the parameters of each printer
included in the directory can be changed, and the printers can be
removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Parameters:

  • i_printer_dir (str) –

  • i_printer_dir_state (int) – enum cat_printer_dir_state

Return type:

None

add_printer_group(i_printer_group_name: str, i_printer_names: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddPrinterGroup(CATBSTR iPrinterGroupName,
CATSafeArrayVariant iPrinterNames)

Add a printer group and define the printers included in this
group.

Parameters:

iPrinterGroupName
printer group name
iPrinterNames
array of printers included in the group.
Parameters:

  • i_printer_group_name (str) –

  • i_printer_names (tuple) –

Return type:

None

get_driver_configuration_path(o_driver_cfg_path: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetDriverConfigurationPath(CATBSTR oDriverCfgPath)

Returns the driver configuration file.

Parameters:

oDriverCfgPath
path of the driver configuration file
Parameters:

o_driver_cfg_path (str) –

Return type:

None

get_driver_configuration_path_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetDriverConfigurationPathInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the driver configuration
file.
Role: Retrieves the state of the driver configuration file in the current
environment.

Parameters:

oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the
administration level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_new_printer_directory(o_new_printer_dir: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetNewPrinterDirectory(CATBSTR oNewPrinterDir)

Returns the directory where new printers will be added.

Parameters:

oNewPrinterDir
directory to add new printers
Role: Each new printer created by an user is added in this
directory.
Parameters:

o_new_printer_dir (str) –

Return type:

None

get_new_printer_directory_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetNewPrinterDirectoryInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the directory where printers will be
added.
Role: Retrieves the state of the directory where printers will be added in
the current environment.

Parameters:

oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the
administration level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_printer_array_for_group(i_printer_group_name: str) → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterArrayForGroup(CATBSTR iPrinterGroupName) As
CATSafeArrayVariant

Returns the definition of the printer group.

Parameters:

iPrinterGroupName
printer group name

Returns:
array of printers included in the group.
Parameters:

i_printer_group_name (str) –

Return type:

tuple

get_printer_directories() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterDirectories() As CATSafeArrayVariant

Returns the directories of printer files.

Returns:
array of directories where 3DPLM printers are defined.
Return type:

tuple

get_printer_directories_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterDirectoriesInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the directories of printer files and
their states.
Role: Retrieves the state of the directories of printer files and their
states in the current environment.

Parameters:

oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the
administration level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

get_printer_directory_state(i_printer_dir: str) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterDirectoryState(CATBSTR iPrinterDir) As
CatPrinterDirState

Returns the state of the directory of printer files.

Parameters:

iPrinterDir
directory where some 3DPLM printers are defined.

Returns:
printer directory state.
Each directory can be protected to prevent user access to the printers
it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each printer
included in the directory cannot be changed.
If the state is CatPrinterDirFree, the parameters of each printer
included in the directory can be changed, and the printers can be
removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Parameters:

i_printer_dir (str) –

Returns:

enum cat_printer_dir_state

Return type:

int

get_printer_groups() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterGroups() As CATSafeArrayVariant

Returns the printer groups.

Returns:
array of printer group names
Return type:

tuple

get_printer_groups_info(o_admin_level: str, o_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPrinterGroupsInfo(CATBSTR oAdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for the definition of each printer
group.
Role: Retrieves the state of the definition of each printer group in the
current environment.

Parameters:

oAdminLevel
If the parameter is locked, oAdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, oAdminLevel gives the
administration level that will give the value of the parameter after a reset.

oLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • o_admin_level (str) –

  • o_locked (str) –

Return type:

bool

modify_printer_array_for_group(i_printer_group_name: str, i_printer_names: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifyPrinterArrayForGroup(CATBSTR iPrinterGroupName,
CATSafeArrayVariant iPrinterNames)

Modify a printer group: redefine the array of printers included in this
group.

Parameters:

iPrinterGroupName
printer group name
iPrinterNames
array of printers included in the group.
Parameters:

  • i_printer_group_name (str) –

  • i_printer_names (tuple) –

Return type:

None

modify_printer_directory_state(i_printer_dir: str, i_printer_dir_state: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ModifyPrinterDirectoryState(CATBSTR iPrinterDir,
CatPrinterDirState iPrinterDirState)

Modify a printer file directory state.

Parameters:

iPrinterDir
directory where some 3DPLM printers are defined.
iPrinterDirState
printer directory state.
Each directory can be protected to prevent user access to the
printers it contains.
The state could be protect or free.
If the state is CatPrinterDirProtect, the parameters of each
printer included in the directory cannot be
changed.
If the state is CatPrinterDirFree, the parameters of each printer
included in the directory can be changed, and the printers can be
removed.
Legal values:
CatPrinterDirProtect : the printers included in the directory are protected.
CatPrinterDirFree : the printers included in the directory are free.
Parameters:

  • i_printer_dir (str) –

  • i_printer_dir_state (int) – enum cat_printer_dir_state

Return type:

None

remove_all_printer_directories() → None

Note

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

Remove all the directories including printer files.
Return type:

None

remove_all_printer_groups() → None

Note

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

Remove all the groups of printers.
Return type:

None

remove_printer_directory(i_printer_dir: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemovePrinterDirectory(CATBSTR iPrinterDir)

Remove a directory of printer files from the directories
list.

Parameters:

iPrinterDir
directory where some 3DPLM printers are defined.
Parameters:

i_printer_dir (str) –

Return type:

None

remove_printer_group(i_printer_group_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemovePrinterGroup(CATBSTR iPrinterGroupName)

Remove a group of printers.

Parameters:

iPrinterGroupName
name of the group to remove.
Parameters:

i_printer_group_name (str) –

Return type:

None

set_driver_configuration_path(i_driver_cfg_path: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDriverConfigurationPath(CATBSTR iDriverCfgPath)

Sets the driver configuration file.

Parameters:

iDriverCfgPath
path of the driver configuration file
Parameters:

i_driver_cfg_path (str) –

Return type:

None

set_driver_configuration_path_lock(i_lock: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDriverConfigurationPathLock(boolean iLock)

Locks or unlocks the driver configuration file.
Role: Locks or unlocks the driver configuration file 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_lock (bool) –

Return type:

None

set_new_printer_directory(i_new_printer_dir: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetNewPrinterDirectory(CATBSTR iNewPrinterDir)

Sets the directory where new printers will be added.

Parameters:

iNewPrinterDir
directory to add new printers
Role: Each new printer created by an user is added in this
directory.
Parameters:

i_new_printer_dir (str) –

Return type:

None

set_new_printer_directory_lock(i_lock: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetNewPrinterDirectoryLock(boolean iLock)

Locks or unlocks the directory where printers will be
added.
Role: Locks or unlocks the directory where printers will be added 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_lock (bool) –

Return type:

None

set_printer_directories_lock(i_lock: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPrinterDirectoriesLock(boolean iLock)

Locks or unlocks the directories of printer files and their
states.
Role: Locks or unlocks the directories of printer files and their states 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_lock (bool) –

Return type:

None

set_printer_groups_lock(i_lock: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPrinterGroupsLock(boolean iLock)

Locks or unlocks the definition of each printer group.
Role: Locks or unlocks the definition of each printer group 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_lock (bool) –

Return type:

None