prg_calendar_next_time_get()
Abstract
Return the schedule time of the next available event.
Syntax
prg_calendar_next_time_get (calendar_handle, time_ptr)
| Argument | Type | Description |
|---|---|---|
calendar_handle |
PrgT_Calendar |
object to query |
time_ptr |
double * |
filled in with the time of the next scheduled event, if available |
Return Type
VosT_Fun_Status
VOSC_SUCCESS if there is an event, VOSC_FAILURE otherwise (in which case time_ptr does not contain a meaningful value)
Header
prg_calendar.h
Details
Events in the calendar are removed one at a time in time-order. This function allows one to obtain the scheduled time of the next event without removing that event from the calendar.