Carbon


PMGetPrintSettingsExtendedData

Header: PMCore.h Carbon status: Supported

Obtains extended print settings data previously stored by your application.

OSStatus PMGetPrintSettingsExtendedData (
    PMPrintSettings printSettings, 
    OSType dataID, 
    UInt32 *size, 
    void *theData
);
Parameter descriptions
printSettings

A PMPrintSettings object.

dataID

The unique 4-character identifier of the data to retrieve. This is typically your application’s creator code.

size

A pointer to a variable specifying the size of the buffer you have allocated for the extended print settings data. On return, this variable contains the number of bytes read into the buffer, or the size of the extended data. You can pass the constant kPMDontWantSize if you do not need this information.

theData

A pointer to a buffer to receive the extended data. Pass the constant kPMDontWantData if you do not want to read the data.

function result

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

DISCUSSION

Your application will typically need to call PMGetPrintSettingsExtendedData two times in order to retrieve the extended print settings data. The first time, pass the constant kPMDontWantData in the extendedData field, to obtain the buffer size required for the extended data. Then call the function a second time to read the extended data into your buffer.

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.


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