2.2.1.15.2 SharedPrinter Element

The <SharedPrinter> inner element refers to a printer made available as a network resource.

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U.

  • Create: This action MUST be used to create a new shared printer connection. If a local printer with the same name exists, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Delete: This action MUST be used to remove a shared printer connection with the same share path. If the printer does not exist, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Replace: This action MUST be used to delete and re-create the shared printer connection. The net result of the Replace action MUST be to overwrite all existing settings associated with the shared printer connection. If the shared printer connection does not exist, then the Replace action MUST create a new shared printer connection.

  • Update: This action MUST be used to modify a shared printer connection. The action differs from Replace in that it MUST update the settings defined within the preference item. All other settings MUST remain as previously configured. If the shared printer connection does not exist, then the Update action MUST create a new shared printer connection.

location

(optional) A text description of the location of this local printer.

path

MUST be set to a fully qualified UNC path of a shared printer.

comment

(optional) A text comment describing this local printer.

default

(optional) MUST be set to 1 to set this printer as the local default printer.

skipLocal

(optional) MUST be set to 1 to bypass changing the default printer if a local printer is configured on the computer.

deleteAll

(optional) MUST be set to 1 to delete all shared printer connections.

port

MUST be set to a local port to which the shared connection is to be mapped.

persistent

(optional) MUST be set to 1 if the shared printer connection is to be persistent.

deleteMaps

(optional) MUST be set to 1 to allow shared printer connections from all local ports. This setting applies only when the preference item's action is set to Delete.

username

(optional) MUST be set to the user name used to connect to the printer driver share.

cpassword

(optional) MUST be set to the password for the username used to connect to the printer driver share. The password is encrypted using an AES-derived encryption key when the preference is created, and decrypted in the client during client processing.

Show: