Carbon


PMGetScale

Header: PMCore.h Carbon status: Supported

Obtains the scaling factor currently applied to the page and paper rectangles.

OSStatus PMGetScale (
    PMPageFormat pageFormat, 
    double *scale
);
Parameter descriptions
pageFormat

A PMPageFormat object.

scale

On return, a pointer to a variable containing the scaling factor expressed as a percentage. For example, a value of 100 means 100 percent (that is, no scaling); a value of 50 means 50 percent scaling.

function result

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

SPECIAL CONSIDERATIONS

Before using this function you must call PMSessionValidatePageFormat or PMValidatePageFormat to ensure that the page format object is valid.

Valid within a printing session after creating a page format object.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


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