![]() |
PMGetPageFormatExtendedData |
||||
Header: | PMCore.h | Carbon status: | Supported | |
Obtains extended page format data previously stored by your application.
OSStatus PMGetPageFormatExtendedData ( PMPageFormat pageFormat, OSType dataID, UInt32 *size, void *theData );
A PMPageFormat object.
The unique 4-character identifier of the data to retrieve. This is typically your applications creator code.
A pointer to a variable specifying the size of the buffer you have allocated for the extended page format 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.
A pointer to a buffer to receive the extended data. Pass the constant kPMDontWantData if you do not want to read the data.
A result code. A result code. See
Your application will typically need to call PMGetPageFormatExtendedData two times in order to retrieve the extended page format 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.
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.
Supported in Carbon. Available in Carbon 1.0.2 and later.
© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)