Carbon


PMGetFirstPage

Header: PMCore.h Carbon status: Supported

Obtains the number of the first page to be printed.

OSStatus PMGetFirstPage (
    PMPrintSettings printSettings, 
    UInt32 *first
);
Parameter descriptions
printSettings

A PMPrintSettings object.

first

On return, a pointer to a variable containing the page number of the first page to print. The default first page number is 1.

function result

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

DISCUSSION

You use this function to obtain the page number entered by the user in the From field of the Print dialog box. If the user did not enter a value, the function returns the value of the previous call to PMSetFirstPage, if any, or the default value of 1.

SPECIAL CONSIDERATIONS

Before using this function you must call PMSessionValidatePrintSettings or PMValidatePrintSettings to ensure that the print settings object is valid.

Valid within a printing session after creating a print settings object.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.

CARBON NOTES

The PMGetFirstPage function replaces the Printing Manager opcode kPrinterDirectOpCode in kPDVerifySelect mode, and obtains information previously stored in the iFstPage field of the Printing Manager structure TPrJob.


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