Carbon


AEResetTimer

Header: AEInteraction.h Carbon status: Supported

Resets the timeout value for an Apple event to its starting value.

OSErr AEResetTimer (
    const AppleEvent *reply
);
Parameter descriptions
reply

A pointer to the default reply for an Apple event, provided by the Apple Event Manager.

function result

A result code.

DISCUSSION

The AEResetTimer function resets the timeout value for an Apple event to its starting value. A server application can call this function when it knows it cannot fulfill a client application’s request (either by returning a result or by sending back a reply Apple event) before the client application is due to time out.

When your application calls AEResetTimer, the Apple Event Manager for the server application uses the default reply to send a Reset Timer event to the client application; the Apple Event Manager for the client application’s computer intercepts this Apple event and resets the client application’s timer for the Apple event. (The Reset Timer event is never dispatched to a handler, so the client application does not need a handler for it.)

AVAILABILITY

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


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)