Carbon


PMSessionSetIdleProc

Header: PMCore.h Carbon status: Supported

Installs an idle callback function in your print loop.

OSStatus PMSessionSetIdleProc (
    PMPrintSession printSession, 
    PMIdleUPP idleProc
);
Parameter descriptions
printSession

A PMPrintSession object.

idleProc

A universal procedure pointer to your idle function. Your idle function is defined by the callback PMIdleProcPtr.

function result

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

DISCUSSION

The Carbon Printing Manager calls your idle function periodically during your print loop. Note that your idle function should not be used to display printing progess information, as that is handled automatically by the Carbon Printing Manager.

SPECIAL CONSIDERATIONS

Valid within the context of a printing session.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.1 and later when running Mac OS 8.1 or later.

CARBON NOTES

PMSessionSetIdleProc is equivalent to setting the TPrJob.pIdleProc field in the Classic Printing Record.


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