Carbon


PMSessionBeginPage

Header: PMApplication.h Carbon status: Supported

Initializes a scaling rectangle for printing a page in the specified printing session.

OSStatus PMSessionBeginPage (
    PMPrintSession printSession, 
    PMPageFormat pageFormat, 
    const PMRect *pageFrame
);
Parameter descriptions
printSession

A PMPrintSession object.

pageFormat

A PMPageFormat object.

pageFrame

A pointer to a bounding rectangle for drawing the page. This value is usually obtained from the PMGetAdjustedPageRect function, but if no scaling is needed, pass NULL. On Mac OS 8 and 9, this parameter is passed to the printer driver. Classic printer drivers typically scale the contents of the page to fit the specified rectangle. This parameter is ignored when running on Mac OS X.

function result

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

DISCUSSION

Because PMSessionBeginPage also initializes the printing port, your application should not make assumptions about the state of the port (for example, the current font) between successive pages. After each call to PMSessionBeginPage, your application should call PMSessionGetGraphicsContext to obtain the current printing port, and set the drawing port to this port using the QuickDraw SetPort function.

SPECIAL CONSIDERATIONS

Valid within the context of a printing session after calling PMSessionBeginDocument.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.1 and later when CarbonLib 1.1 or later is present.

CARBON NOTES

PMSessionBeginPage is equivalent to the Classic Printing Manager function PrOpenPage.


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