Intermec 5055 Reference Guide
im_set_time_event
5-69
5
im_set_time_event
Purpose:
This function starts a timer that runs from 0 to 65,534 ms. After reaching the upper
limit, a timeout event occurs that can be recognized by the im_event_wait function or
any of the input functions.
limit, a timeout event occurs that can be recognized by the im_event_wait function or
any of the input functions.
Syntax:
#include "im5055.h"
IM_STATUS im_set_time_event
(IM_USHORT
IM_STATUS im_set_time_event
(IM_USHORT
iTimeout
)
IN Parameters:
iTimeout Number of milliseconds, from 0 to 65,534, to wait before a timeout event
occurs.
occurs.
OUT Parameters:
None.
Return Value:
This function returns one of these codes:
IM_SUCCESS Successfully started timer.
E_TABLE_FULL No more timer services available, timeout not established.
Notes:
The timer is accurate within 5 ms. If you call this function again before the timer
reaches the value passed in, the timer is reset to 0 and starts counting toward the passed
in value again.
reaches the value passed in, the timer is reset to 0 and starts counting toward the passed
in value again.
When the timeout occurs and IM_TIMER_SELECT is an allowed source for the
im_event_wait or im_event_status function, IM_TIMER_SELECT is returned as the
source for that function.
im_event_wait or im_event_status function, IM_TIMER_SELECT is returned as the
source for that function.
See Also:
im_event_wait, im_receive_input, im_receive_field
Example
See example for im_event_wait.