DRV_CheckEvent

INT32S CheckEvent (
   PTR_T DeviceHandle, 
   PT_CheckEvent *lpCheckEvent );

Purpose

On the device indicated by the DeviceHandle, it checks the specified event status and clears the event.

Parameters

Some parameters, such as event type (EventType) and timeout (Milliseconds), are stored in the PT_CheckEvent, structure pointed by the lpCheckEvent.

Name Direction Range Description
DeviceHandle input default The pointer retrieved from the DRV_DeviceOpen which specifies the target device.
lpCheckEvent input / output default Pointer to the user-prepared structure PT_CheckEvent that stores event type (INT32U  EventType) and time-out interval (INT32U Milliseconds).

Return

   1. 0 Successful.
   2. InvalidDeviceHandle The DeviceHandle is NULL.
   3. CheckEventFailed An error occurs when checking the event. The error cause is unknown. Please try to initiate the function again.