User`s guide

FUNCTIONS

SDK SECTION 11

Page 212

SetDriverEvent

unsigned int WINAPI SetDriverEvent(HANDLE driverEvent)

Description

This function passes a Win32 Event handle to the SDK via which the the user software

can be informed that something has occurred. For example the SDK can “set” the event

when an acquisition has completed thus relieving the user code of having to continually

pole to check on the status of the acquisition.

The event will be “set” under the follow conditions:

1) Acquisition completed or aborted.

2) As each scan during an acquisition is completed.

3) Temperature as stabilized, drifted from stabilization or could not be reached.

When an event is triggered the user software can then use other SDK functions to

determine what actually happened.

Condition 1 and 2 can be tested via

GetStatus function, while condition 3 checked via

GetTemperature function.

You must reset the event after it has been handled in order to receive additional triggers.

Before deleting the event you must call SetDriverEvent with NULL as the parameter.

Parameters

HANDLE driverEvent: Win32 event handle.

Return

unsigned int

DRV_SUCCESS

DRV_NOT_INITIALIZED

DRV_NOT_SUPPORTED

Event set.

System not initialized.

Function not supported for operating system