Back to Aurora Vision Library Lite website
You are here: Start » Camera Support » IDS » IDS_CaptureStatus
IDS_CaptureStatus
Header: | ThirdPartySdk.h |
---|---|
Namespace: | avl |
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 avl::IDS_CaptureStatus ( IDS_BaseState& ioState, const atl::Optional<atl::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 | |
---|---|---|---|---|
ioState | IDS_BaseState& | Object used to maintain state of the function. | ||
inDeviceID | const Optional<String>& | NIL | Device serial number or user definable camera ID | |
inReset | bool | Resets the CaptureStatus information | ||
outNumberOfErrors | int& | Total number of errors | ||
outNoDestMem | int& | There is no destination memory for copying the finished image. | ||
outConversionFailed | int& | The current image could not be processed correctly. | ||
outImageLocked | int& | The destination buffers are locked and could not be written to. | ||
outOutOfBuffers | int& | No free internal image memory is available to the driver. The image was discarded. | ||
outDeviceNotReady | int& | The camera is no longer available. It is not possible to access images that have already been transferred. | ||
outUsbTransferFailed | int& | The image was not transferred over the USB bus. | ||
outDevTimeout | int& | The maximum allowable time for image capturing in the camera was exceeded. | ||
outEthBufferOverrun | int& | The sensor transfers more data than the internal camera memory of the GigE uEye camera can accommodate. | ||
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. | ||
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.