function retrieves or modifies printer initialization information or displays
a printer-configuration dialog box for the specified printer.
| HWND hWnd,
||// handle to window that displays dialog box
| HANDLE hPrinter,
||// handle to printer object
| LPTSTR pDeviceName,
||// pointer to device name
| PDEVMODE pDevModeOutput,
||// pointer to modified device mode structure
| PDEVMODE pDevModeInput,
||// pointer to original device mode structure
| DWORD fMode
||// mode flag
Identifies the parent window of the printer-configuration dialog box.
Identifies a printer object.
Points to a null-terminated string that specifies the name of the device for
which the printer-configuration dialog box should be displayed.
Points to a DEVMODE
structure that receives the printer configuration data specified by the user.
Pointer to a DEVMODE
structure that the operating system uses to initialize the dialog box
This parameter is only used if the DM_IN_BUFFER flag is set in the fMode
parameter. If DM_IN_BUFFER is not set, the operating system uses the
printer's default DEVMODE
Specifies a mask of values that determines the operations the function
performs. If this parameter is zero, the DocumentProperties
function returns the number of bytes required by the printer driver's DEVMODE
data structure. Otherwise, use one or more of the following constants to
construct a value for this parameter; note, however, that in order to change the
print settings, an application must specify at least one input value and one
||Input value. Before prompting, copying, or updating, the function merges the
printer driver's current print settings with the settings in the DEVMODE structure specified by the pDevModeInput parameter. The function updates the structure only for those members
specified by the DEVMODE structure's dmFields member. This value is also defined as DM_MODIFY. In cases of conflict during
the merge, the settings in the DEVMODE structure specified by pDevModeInput override the printer driver's current print settings.
||Input value. The function presents the printer driver's Print Setup dialog box
and then changes the settings in the printer's DEVMODE data structure to those values specified by the user. This value is also
defined as DM_PROMPT.
||Output value. The function writes the printer driver's current print settings,
including private data, to the DEVMODE data structure specified by the pDevModeOutput parameter. The caller must allocate a buffer sufficiently large to contain
the information. If the bit DM_OUT_BUFFER sets is clear, the pDevModeOutput parameter can be NULL. This value is also defined as DM_COPY.
If the fMode
parameter is zero, the return value is the size of the buffer required to
contain the printer driver initialization data. Note that this buffer can be
larger than a DEVMODE
structure if the printer driver appends private data to the structure.
If the function displays the initialization dialog box, the return value is
either IDOK or IDCANCEL, depending on which button the user selects.
If the function does not display the dialog box and is successful, the return
value is IDOK.
If the function fails, the return value is less than zero.
The printer object handle identified by the hPrinter
parameter can be obtained by calling the OpenPrinter
The string pointed to by the pDeviceName
parameter can be obtained by calling the GetPrinter
Note that the DEVMODE
structure actually used by a printer driver contains the device-independent
part (as defined above) followed by a driver-specific part that varies in size
and content with each driver and driver version. Because of this driver
dependence, it is very important for applications to query the driver for the correct
size of the DEVMODE
structure before allocating a buffer for it.
To make changes to print settings that are local to an application, an
application should follow these steps:
- Get the number of bytes required for the full DEVMODE structure by calling DocumentProperties and specifying zero in the fMode parameter.
- Allocate memory for the full DEVMODE structure.
- Get the current printer settings by calling DocumentProperties. Pass a pointer to the DEVMODE structure allocated in Step 2 as the pDevModeOutput parameter and specify the DM_OUT_BUFFER value.
- Modify the appropriate members of the returned DEVMODE structure and indicate which members were changed by setting the
corresponding bits in the dmFields member of the DEVMODE.
- Call DocumentProperties and pass the modified DEVMODE structure back as both the pDevModeInput and pDevModeOutput parameters and specify both the DM_IN_BUFFER and DM_OUT_BUFFER values (which
are combined using the OR operator).
structure returned by the third call to DocumentProperties
can be used as an argument in a call to the CreateDC
To create a handle to a printer-device context using the current printer
settings, you only need to call DocumentProperties
twice, as described above. The first call gets the size of the full DEVMODE
and the second call initializes the DEVMODE
with the current printer settings. Pass the initialized DEVMODE
to obtain the handle to the printer device context.
- Software for developers
Software for Android Developers
- More information resources
Unix Manual Pages
- Databases for Amazon shops developers
Amazon Categories Database
Browse Nodes Database