Back to FabImage Library website

You are here: Start » Function Reference » Camera Support » IDS » IDS_CaptureStatus

IDS_CaptureStatus


Header: ThirdPartySdk.h
Namespace: fil
Module: ThirdParty

The function returns information on errors that occurred during an image capture. All errors are listed that occurred since the last reset of the function.

Syntax

void fil::IDS_CaptureStatus
(
	IDS_BaseState& ioState,
	const ftl::Optional<ftl::String>& inDeviceID,
	bool inReset,
	int& outNumberOfErrors,
	int& outNoDestMem,
	int& outConversionFailed,
	int& outImageLocked,
	int& outOutOfBuffers,
	int& outDeviceNotReady,
	int& outUsbTransferFailed,
	int& outDevTimeout,
	int& outEthBufferOverrun,
	int& outEthDevMissedImages,
	int& outFrameCaptureFailed
)

Parameters

Name Type Default Description
Input will be modified ioState IDS_BaseState& Object used to maintain state of the function.
Input value inDeviceID const Optional<String>& NIL Device serial number or user definable camera ID
Input value inReset bool Resets the CaptureStatus information
Output value outNumberOfErrors int& Total number of errors
Output value outNoDestMem int& There is no destination memory for copying the finished image.
Output value outConversionFailed int& The current image could not be processed correctly.
Output value outImageLocked int& The destination buffers are locked and could not be written to.
Output value outOutOfBuffers int& No free internal image memory is available to the driver. The image was discarded.
Output value outDeviceNotReady int& The camera is no longer available. It is not possible to access images that have already been transferred.
Output value outUsbTransferFailed int& The image was not transferred over the USB bus.
Output value outDevTimeout int& The maximum allowable time for image capturing in the camera was exceeded.
Output value outEthBufferOverrun int& The sensor transfers more data than the internal camera memory of the GigE uEye camera can accommodate.
Output value outEthDevMissedImages int& Freerun mode: The camera could neither process nor output an image captured by the sensor. Hardware trigger mode : The camera received a hardware trigger signal which could not be processed because the sensor was still busy.
Output value outFrameCaptureFailed int& USB 3 uEye CP Rev. 2 with activated image memory only: The image was not transferred.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.