PhTimerArm()

Arm a timer event

Synopsis:

int PhTimerArm ( PhRid_t rid, 
                 long handle, 
                 unsigned msec );

Description:

The PhTimerArm() arms a timer event on the region specified by rid to be triggered after msec milliseconds. The handle argument is returned in the timer event. See PhT.h for information about the timer event structure.

Note:

Don't use PhTimerArm() in an application that uses widgets - use PtTimerArm() instead. The widget library assumes that the handle received in a timer event is a pointer to the widget to which the event is directed.

Returns:

0: Successful completion.
-1: An error occurred.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also: