PhTimerArm()

Arm a timer event

Synopsis:

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

Library:

ph

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.

---

Don't use PhTimerArm() in an application that uses widgets -- use PtTimerArm() or RtTimerCreate() instead.

---

Returns:

A nonnegative value

Successful completion.

-1

An error occurred.

Classification:

Photon

See also:

PtTimerArm(), RtTimerCreate(), RtTimerDelete(), RtTimerGetTime(), RtTimerSetTime()

"Timers" in the Working with Code chapter of the Photon Programmer's Guide