THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH
4 Programming (SDK)
221
4.3.27 is_ForceTrigger
USB 2.0
USB 3.0
USB 2.0
USB 3.0
Syntax
INT is_ForceTrigger (HIDS hCam)
Description
You can use is_ForceTrigger() to force a software-controlled capture of an image while a capturing process
triggered by hardware is in progress. This function can only be used if the triggered capturing process was started
using the IS_DONT_WAIT parameter.
Input parameters
hCam
Camera handle
Return values
IS_CANT_COMMUNICATE_WITH_DRIVER
Communication with the driver failed because no driver
has been loaded.
IS_CANT_OPEN_DEVICE
An attempt to initialize or select the camera failed (no
camera connected or initialization error).
IS_INVALID_CAMERA_HANDLE
Invalid camera handle
IS_INVALID_PARAMETER
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
available in this mode.
IS_IO_REQUEST_FAILED
An IO request from the uc480 driver failed. Possibly the
versions of the uc480_api.dll (API) and the driver file
(uc480_usb.sys) do not match.
IS_NO_SUCCESS
General error message
IS_SUCCESS
Function executed successfully
Related functions
is_FreezeVideo()
is_CaptureVideo()
is_SetExternalTrigger()
Example
Enable trigger and wait 1 second for the external trigger. If no trigger signal has arrived, force an exception using
is_ForceTrigger().
HANDLE hEvent = CreateEvent(NULL, TRUE, FALSE, "");
if ( hEvent != NULL )
{
is_InitEvent(hCam, m_hEvent, IS_SET_EVENT_FRAME);
is_EnableEvent(hCam, IS_SET_EVENT_FRAME);
is_SetExternalTrigger(hCam, IS_SET_TRIGGER_HI_LO);
is_FreezeVideo(hCam, IS_DONT_WAIT);
if (WaitForSingleObject(m_hEvent, 1000) != WAIT_OBJECT_0)
{
// No trigger has been received, so force image capture
is_ForceTrigger(hCam);
}
is_DisableEvent(hCam, IS_SET_EVENT_FRAME);
is_ExitEvent(hCam, IS_SET_EVENT_FRAME);
}
223
177
327

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English