Carbon


PMBeginPage

Header: PMApplication.h Carbon status: Supported

Initializes a scaling rectangle for printing a page.

OSStatus PMBeginPage (
    PMPrintContext printContext, 
    const PMRect *pageFrame
);
Parameter descriptions
printContext

A PMPrintContext 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 PMBeginPage 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 PMBeginPage, your application should call PMGetGrafPtr to obtain the current printing port, and set the drawing port to this port using the QuickDraw SetPort function.

PMSessionBeginPage is recommended instead of PMBeginPage.

SPECIAL CONSIDERATIONS

Valid after calling PMBegin and PMBeginDocument.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.

CARBON NOTES

The PMBeginPage function replaces the Printing Manager function PrOpenPage.


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