---

RtTimerGetTime()

Get the time remaining on a realtime timer

Synopsis:

#include <photon/realtime/RtTimer.h>

int RtTimerGetTime( RtTimer_t *timer,
                    struct itimerspec *value );

Arguments:

timer

A pointer to a RtTimer_t that was created by a call to RtTimerCreate().

value

A pointer to a itimerspec structure in which to store the remaining time.

Library:

ph

Description:

This function gets the time remaining on the realtime timer identified by the structure pointed to by timer. The time remaining is put into the structure pointed to by value.

Returns:

0

Success.

-1

An error occurred; errno is set.

Errors:

EINVAL

The given timer isn't attached to the calling process.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

RtTimerCreate(), RtTimerDelete(), RtTimerSetTime()

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

timer_gettime() in the QNX Neutrino Library Reference

---