All Frameworks  Object Hierarchy  This Framework  Indexes

PrintersSettingAtt (Object)

Represents a setting controller for the printer settings.
Role: This interface is implemented by a component which represents the controller of the printer settings.

Method Index

AddPrinterDirectory
Add a printer file directory to printer directories list and define its state.
AddPrinterGroup
Add a printer group and define the printers included in this group.
GetDriverConfigurationPathInfo
Retrieves environment informations for the driver configuration file.
GetDriverConfigurationPath
Returns the driver configuration file.
GetNewPrinterDirectoryInfo
Retrieves environment informations for the directory where printers will be added.
GetNewPrinterDirectory
Returns the directory where new printers will be added.
GetPrinterArrayForGroup
Returns the definition of the printer group.
GetPrinterDirectoriesInfo
Retrieves environment informations for the directories of printer files and their states.
GetPrinterDirectories
Returns the directories of printer files.
GetPrinterDirectoryState
Returns the state of the directory of printer files.
GetPrinterGroupsInfo
Retrieves environment informations for the definition of each printer group.
GetPrinterGroups
Returns the printer groups.
ModifyPrinterArrayForGroup
Modify a printer group: redefine the array of printers included in this group.
ModifyPrinterDirectoryState
Modify a printer file directory state.
RemoveAllPrinterDirectories
Remove all the directories including printer files.
RemoveAllPrinterGroups
Remove all the groups of printers.
RemovePrinterDirectory
Remove a directory of printer files from the directories list.
RemovePrinterGroup
Remove a group of printers.
SetDriverConfigurationPathLock
Locks or unlocks the driver configuration file.
SetDriverConfigurationPath
Sets the driver configuration file.
SetNewPrinterDirectoryLock
Locks or unlocks the directory where printers will be added.
SetNewPrinterDirectory
Sets the directory where new printers will be added.
SetPrinterDirectoriesLock
Locks or unlocks the directories of printer files and their states.
SetPrinterGroupsLock
Locks or unlocks the definition of each printer group.

Methods


o Sub AddPrinterDirectory( iPrinterDir,
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.
o Sub AddPrinterGroup( iPrinterGroupName,
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.
o Func GetDriverConfigurationPathInfo( oAdminLevel,
oLocked) As
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.
o Sub GetDriverConfigurationPath( oDriverCfgPath)
Returns the driver configuration file.
Parameters:
oDriverCfgPath
path of the driver configuration file
o Func GetNewPrinterDirectoryInfo( oAdminLevel,
oLocked) As
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.
o Sub GetNewPrinterDirectory( 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.
o Func GetPrinterArrayForGroup( iPrinterGroupName) As
Returns the definition of the printer group.
Parameters:
iPrinterGroupName
printer group name
Returns:
array of printers included in the group.
o Func GetPrinterDirectoriesInfo( oAdminLevel,
oLocked) As
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.
o Func GetPrinterDirectories() As
Returns the directories of printer files.
Returns:
array of directories where 3DPLM printers are defined.
o Func GetPrinterDirectoryState( iPrinterDir) As
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.
o Func GetPrinterGroupsInfo( oAdminLevel,
oLocked) As
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.
o Func GetPrinterGroups() As
Returns the printer groups.
Returns:
array of printer group names
o Sub ModifyPrinterArrayForGroup( iPrinterGroupName,
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.
o Sub ModifyPrinterDirectoryState( iPrinterDir,
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.
o Sub RemoveAllPrinterDirectories()
Remove all the directories including printer files.
o Sub RemoveAllPrinterGroups()
Remove all the groups of printers.
o Sub RemovePrinterDirectory( iPrinterDir)
Remove a directory of printer files from the directories list.
Parameters:
iPrinterDir
directory where some 3DPLM printers are defined.
o Sub RemovePrinterGroup( iPrinterGroupName)
Remove a group of printers.
Parameters:
iPrinterGroupName
name of the group to remove.
o Sub SetDriverConfigurationPathLock( 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.
o Sub SetDriverConfigurationPath( iDriverCfgPath)
Sets the driver configuration file.
Parameters:
iDriverCfgPath
path of the driver configuration file
o Sub SetNewPrinterDirectoryLock( 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.
o Sub SetNewPrinterDirectory( 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.
o Sub SetPrinterDirectoriesLock( 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.
o Sub SetPrinterGroupsLock( 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.

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