Carbon


PMSessionPageSetupDialog

Header: PMApplication.h Carbon status: Supported

Displays the Page Setup dialog box and records the user’s selections in a PMPageFormat object.

OSStatus PMSessionPageSetupDialog (
    PMPrintSession printSession, 
    PMPageFormat pageFormat, 
    Boolean *accepted
);
Parameter descriptions
printSession

A PMPrintSession object.

pageFormat

A PMPageFormat object.

accepted

Returns true if the user clicks the OK button, or false if the user clicks Cancel.

function result

A result code. A result code. See “Result Codes”.

DISCUSSION

When the Page Setup dialog box is displayed, it shows the current settings contained in the page format object. If the user changes these settings and clicks the OK button, the page format object is updated with the user’s selections. If the user clicks the Cancel button, the page format object is returned unchanged.

SPECIAL CONSIDERATIONS

Valid within the context of a printing session. Never call PMSessionPageSetupDialog between the pages of a document.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.1 and later when running Mac OS 8.1 or later.

CARBON NOTES

PMSessionPageSetupDialog is equivalent to the Classic Printing Manager function PrStlDialog.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)