PageSetupDlg (function)
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This function creates a Page Setup dialog box that enables the user to specify the attributes of a printed page. These attributes include the paper size and source, the page orientation — portrait or landscape — and the width of the page margins.
For Windows CE 2.10 and later, this function replaces the PrintDlg (function) function.
Syntax
BOOL PageSetupDlg(
LPPAGESETUPDLG lppsd
);
Parameters
- lppsd
Long pointer to a PAGESETUPDLG (structure) that contains information used to initialize the dialog box. The structure receives information about the user's selections when the function returns.
Return Value
If the user clicks the OK button, the return value is nonzero. The members of the PAGESETUPDLG structure pointed to by the lppsd parameter indicate the user's selections.
If the user cancels or closes the Page Setup dialog box or an error occurs, the return value is zero. To get extended error information, use the CommDlgExtendedError function. One of the values shown in the following table is returned.
| Value | Value |
|---|---|
CDERR_DIALOGFAILURE |
CDERR_NOTEMPLATE |
CDERR_FINDRESFAILURE |
CDERR_REGISTRYFAILURE |
CDERR_INITIALIZATION |
CDERR_STRUCTSIZE |
CDERR_LOADRESFAILURE |
PDERR_CREATEDCFAILURE |
CDERR_LOADSTRFAILURE |
PDERR_NOPORTS |
CDERR_LOCKRESFAILURE |
PDERR_NOPRINTERS |
CDERR_MEMALLOCFAILURE |
PDERR_PRINTERNOTFOUND |
CDERR_NOHINSTANCE |
PDERR_RETDEFFAILURE |
CDERR_NOHOOK |
|
For more information about these error values, see CommDlgExtendedError.
Remarks
The PageSetupDlg function is not supported in version 2.0.
To create your own print dialog, you must use the dialog template. Items on this template cannot be deleted however, items can be hidden, modified, and added.
The PageSetupDlg function fills the DEVNAMES structure with byte offsets rather than the expected character offsets.
Requirements
| Header | commdlg.h |
| Library | commdlg.lib |
| Windows Embedded CE | Windows CE 2.10 and later |
See Also
Reference
CommDlgExtendedError
PrintDlg (function)
DEVNAMES
PAGESETUPDLG (structure)