XtAppAddTim(3x) — HPUX 9.05

XtAppAddTimeOut − register a procedure to be called when a specified time elapses.

Synopsis

XtIntervalId XtAppAddTimeOut(app_context, interval, proc, client_data)

    XtAppContext app_context;
    unsigned long interval;
    XtTimerCallbackProc proc;
    XtPointer client_data;

Inputs

app_context
Specifies the application context in which the timer is to be set.

intervalSpecifies the time interval in milliseconds.

procSpecifies the procedure that is to be called when the time expires. See XtTimerCallbackProc(2).

client_data
Specifies data to be passed to proc when it is called.

Returns

A handle of type XtIntervalId that can be used to unregister the timeout procedure with XtRemoveTimeOut().

Description

XtAppAddTimeOut() registers, in application context app_context, a procedure proc, to be called by XtAppNextEvent() with client_data after interval milliseconds elapse. The procedure is called once and automatically unregistered; it will not be called repeatedly every interval milliseconds. See XtTimerCallbackProc(2) for an explanation of how to write a timer callback.

Usage

Timer callbacks are automatically unregistered after they are triggered. To have a callback called at a regular interval, call XtAppAddTimeOut() again from within the timer callback. A timer callback can be explicitly unregistered before it is invoked by calling XtRemoveTimeOut() with the XtIntervalId returned by this function.

Structures

The XtIntervalId type is defined as follows:

typedef unsigned long XtIntervalId;

Museum