Carbon


PMError

Header: PMCore.h Carbon status: Not Recommended

Obtains the result code from the last Carbon Printing Manager function called by your application.

OSStatus PMError ();
function result

A result code. A result code. See “Result Codes”. The result code kPMCancel indicates the user canceled the current print job.

DISCUSSION

You can use this function to determine whether the user has canceled the current print job. The result code kPMCancel is returned if the user clicks the Cancel button in the printer driver’s status dialog box. If this or any other error is encountered during the print loop, your application should call the appropriate “end” routines (for example, PMEndPage and PMEndDocument) to exit the print loop before reporting the error.

PMSessionError is recommended instead of PMError.

SPECIAL CONSIDERATIONS

Valid after calling PMBegin.

AVAILABILITY

Not recommended in Carbon. Available in Carbon 1.0.2 and later.

CARBON NOTES

The PMError function replaces the Printing Manager function PrError. However, you should reduce your application use of PMError and instead respond to result codes as soon as they are returned by Carbon Printing Manager functions.


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