Print U I Users Guide

Download as doc, pdf, or txt
Download as doc, pdf, or txt
You are on page 1of 11

PrintUI.

DLL Users Guide and Reference


Microsoft Corporation
Published: February 2005

Abstract
System administrators may automate many printer configuration functions using scripts and printui.dll. Printui.dll
is the executable file containing the functions used by the printer configuration dialogs. These functions may also
be called from within a script, a batch file, or interactively from a command line. This paper describes how the
basic functions provided by printui.dll may be used in common system administration tasks.

Microsoft Windows Server 2003 White Paper

The information contained in this document represents the current view of


Microsoft Corporation on the issues discussed as of the date of
publication. Because Microsoft must respond to changing market
conditions, it should not be interpreted to be a commitment on the part of
Microsoft, and Microsoft cannot guarantee the accuracy of any
information presented after the date of publication.
This White Paper is for informational purposes only. MICROSOFT
MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS
TO THE INFORMATION IN THIS DOCUMENT.
Complying with all applicable copyright laws is the responsibility of the
user. Without limiting the rights under copyright, no part of this document
may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical,
photocopying, recording, or otherwise), or for any purpose, without the
express written permission of Microsoft Corporation.
Microsoft may have patents, patent applications, trademarks, copyrights,
or other intellectual property rights covering subject matter in this
document. Except as expressly provided in any written license
agreement from Microsoft, the furnishing of this document does not give
you any license to these patents, trademarks, copyrights, or other
intellectual property.
2005 Microsoft Corporation. All rights reserved.
Microsoft, Windows, Windows NT, Windows XP, Windows Server 2003,
Windows Server System, and the Windows logo are either registered
trademarks or trademarks of Microsoft Corporation in the United States
and/or other countries.
All other trademarks are property of their respective owners.

Microsoft Windows Server 2003 White Paper

Contents
Introduction................................................................................................................................... 1
Common Tasks............................................................................................................................. 2
Add a new printer........................................................................................................................ 2
Delete an existing printer............................................................................................................. 2
Add a per-machine connection.................................................................................................... 2
Remove per-machine connections.............................................................................................. 3
PrintUI.DLL Reference.................................................................................................................. 4
Usage.......................................................................................................................................... 4
Options........................................................................................................................................ 4
PrintUIEntry command options................................................................................................ 4
PrintUIEntry modification options............................................................................................. 5
Related Links................................................................................................................................ 7

Microsoft Windows Server 2003 White Paper

Introduction
System administrators may automate many printer configuration functions using scripts and printui.dll.
Printui.dll is the executable file containing the functions used by the printer configuration dialogs. These
functions may also be called from within a script, a command line batch file or run interactively from the
command line.
This paper describes the basic functions provided by printui.dll and how they may be used in common
system administration tasks. The tasks covered in this document are:

Add a new printer

Delete an existing printer

Add a per-machine connection

Remove per-machine connections

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

Common Tasks
This section presents some of the most common printer configuration tasks and how they can be
automated by calling printui.dll functions from the command line or from a batch file.
When executing the commands shown in the examples below, note that the PrintUIEntry keyword on
the command line is case sensitive, and must be entered with the exact capitalization shown.
When entering the \\machine\printer string you must substitute machine with the correct print server
name and printer with the name of the desired printer hosted on that print server. Run the command on
the machine on which you wish to install or remove the printer.

Add a new printer


Installs a new remote printer on the client machine. This command will add a printer that is visible only
to the account of the user executing the command. To add printers visible to all users of the client
machine, see the Add a per-machine connection command described below.
Command Line:
rundll32 printui.dll PrintUIEntry /in /n\\machine\printer
Printers with in-box drivers may be installed by referencing the ntprint.inf file as shown in the following
example:
Command Line:
rundll32 printui.dll PrintUIEntry /if /f %windir%\inf\ntprint.inf /r "lpt1:" /m "HP PSC
500"
In the sample command line above, substitute lpt1: with the port your printer is connected to. Also,
substitute "HP PSC 500" with the model name of the printer you are installing. The model name used
must exactly match the printers entry in the ntprint.inf file.
Using the /if option with an INF file supports more configuration options giving the administrator more
ways to configure the printer installation from the script.

Delete an existing printer


Removes an existing printer from the client machine.
Command Line:
rundll32 printui.dll PrintUIEntry /dn /n\\machine\printer

Add a per-machine connection


Adds a per-machine connection to the client machine. A per-machine connection is a printer configured
to be accessible by all users of the client machine. Normally, when a user adds a printer to a client
machine, the printer is visible only to the account used by the person adding the printer. This command
must be run by a local admin of the client machine.
Command Line:

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

rundll32 printui.dll PrintUIEntry /ga /n\\machine\printer

Remove per-machine connections


Removes a per-machine connection from the client machine.
Command Line:
rundll32 printui.dll PrintUIEntry /gd /n\\machine\printer

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

PrintUI.DLL Reference
This section lists the command line options supported by printui.dll.

Usage
When executing the command shown below note that the PrintUIEntry keyword on the command line
is case sensitive, and must be entered with the exact capitalization shown.
rundll32 printui.dll PrintUIEntry [options] [@commandfile]
Replace [options] in the command line above with one or more of the options described in the
following section or use a command file containing multiple options as desired.

Options
The options listed below are those displayed by executing the following command and reprinted here
for your convenience.
rundll32 printui.dll PrintUIEntry /?
Bold text identifies the rundll32 command line options with the description of the option following in
normal text. Strings delimited by brackets, such as [file] should be replaced as described in the
command description. The string to replace includes the brackets. For example, to use the /n option
used to enter the printer name and described in the text below as:
/n[name] printer name
And your printer was named \\machine\printer, the complete option would be entered as:
/n\\machine\printer
PrintUIEntry command options
These command options determine the function to be performed by the command. Only one of these
options may appear in a command line. The command may be modified by one or more of the
modification options listed below. Note that not all modification options are supported by all command
options.
/? Help this message
/dd delete printer driver
/dl delete local printer
/dn delete network printer connection
/e display printing preferences
/ga add per machine printer connections
/ge enum per machine printer connections
/gd delete per machine printer connections

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

/ia install printer driver using inf file


/id install printer driver using add printer driver wizard
/if install printer using inf file
/ii install printer using add printer wizard with an inf file
/il install printer using add printer wizard
/in add network printer connection
/k print test page to specified printer, cannot be combined with command when installing a printer
/o display printer queue view
/p display printer properties
/s display server properties
/Ss Store printer settings into a file
/Sr Restore printer settings from a file
Store or restore printer settings option flags that must be placed at the end of command:
2

PRINTER_INFO_2

PRINTER_INFO_7

Color Profile

PrinterData

Security descriptor

Global DevMode

Minimal settings

User DevMode

Resolve name conflicts

Force name

Resolve port

/Xg get printer settings


/Xs set printer settings
/y set printer as the default
@[file] command line argument file
PrintUIEntry modification options
These options are used to modify the command option or provide additional information to the selected
command.
/a[file] binary file name

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

/b[name] base printer name


/c[name] unc machine name if the action is on a remote machine
/f[file] either inf file or output file
/h[arch] driver architecture one of the following, Alpha | Intel | IA64 | x64
/j[provider] print provider name
/l[path] printer driver source path
/m[model] printer driver model name
/n[name] printer name
/q quiet mode, do not display error messages
/r[port] port name
/u use the existing printer driver if it's already installed
/t[#] zero based index page to start on
/v[version] driver version one of the following, Windows 95, 98 and Me | Windows NT 4.0 | Windows
NT 4.0 or 2000 | Windows 2000 or XP | Windows XP
/w prompt the user for a driver if specified driver is not found in the inf
/z do not auto share this printer
/Y do not auto generate a printer name
/K changes the meaning of /v and /h to accept 0,1,2,3, respectively for Windows x64 and Windows
IA64 | Windows NT x86 | Windows NT Alpha_AXP | Windows 4.0
/Z share this printer, can only be used with the /if option
/Mw[message] show a warning message before committing the command
/Mq[message] show a confirmation message before committing the command
/W[flags] specifies flags and switches for the wizards (for APW & APDW)
r

make the wizards to be restart-able from the last page

/G[flags] specifies global flags and switches


w

suppress setup driver warnings UI (super quiet mode)

PrintUI.DLL Users Guide and Reference

Microsoft Windows Server 2003 White Paper

Related Links
For the latest information about Windows Server 2003, see the Windows Server 2003 Web site at
http://www.microsoft.com/windowsserver2003.

PrintUI.DLL Users Guide and Reference

You might also like