Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xtappaddtimeout(3) [hpux man page]

XtAppAddTimeOut()														 XtAppAddTimeOut()

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.

  interval  Specifies the time interval in milliseconds.

  proc	    Specifies 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 XtAppAd-
  dTimeOut() 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;

See Also
  XtAppNextEvent(1), XtRemoveTimeOut(1),
  XtTimerCallbackProc(2).

Xt - Event Handling														 XtAppAddTimeOut()

Check Out this Related Man Page

XtAppAddTimeOut(3Xt)						   XT FUNCTIONS 					      XtAppAddTimeOut(3Xt)

NAME
XtAppAddTimeOut, XtRemoveTimeOut - register and remove timeouts SYNTAX
XtIntervalId XtAppAddTimeOut(app_context, interval, proc, client_data) XtAppContext app_context; unsigned long interval; XtTimerCallbackProc proc; XtPointer client_data; void XtRemoveTimeOut(timer) XtIntervalId timer; ARGUMENTS
app_context Specifies the application context for which the timer is to be set. client_data Specifies the argument that is to be passed to the specified procedure when . interval Specifies the time interval in milliseconds. proc Specifies the procedure that is to be called when time expires. timer Specifies the ID for the timeout request to be destroyed. DESCRIPTION
The XtAppAddTimeOut function creates a timeout and returns an identifier for it. The timeout value is set to interval. The callback pro- cedure is called when the time interval elapses, and then the timeout is removed. The XtRemoveTimeOut function removes the timeout. Note that timeouts are automatically removed once they trigger. SEE ALSO
XtAppAddInput(3Xt),XtAppAddSignal(3Xt) X Toolkit Intrinsics - C Language Interface Xlib - C Language X Interface X Version 11 Release 6.6 XtAppAddTimeOut(3Xt)
Man Page