is_CaptureStatus

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_CaptureStatus (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)

Description

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.

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.

Hinweis

Note to the function

The following functions are obsolete by the is_CaptureStatus() function:

•is_GetCaptureErrorInfo()

•is_ResetCaptureErrorInfo()

See also Obsolete functions.

Input parameters

hCam

Camera handle

IS_CAPTURE_STATUS_INFO_CMD_GET	Returns the CaptureStatus information (Example 1)
IS_CAPTURE_STATUS_INFO_CMD_RESET	Resets the CaptureStatus infomation (Examplel 2)

pParam

Pointer to a function parameter, whose function depends on nCommand.

cbSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Content of the UEYE_CAPTURE_STATUS enumeration

IS_CAP_STATUS_API_NO_DEST_MEM

There is no destination memory for copying the finished image.

Not enough destination memory allocated or all destination buffers locked by the application.

•Release locked destination memory

•Allocate more destination memory

•Reduce the frame rate so that there is more time to process the filled destination memory

IS_CAP_STATUS_API_CONVERSION_FAILED

The current image could not be processed correctly.

Internal error during internal processing of the image

IS_CAP_STATUS_API_IMAGE_LOCKED

The destination buffers are locked and could not be written to.

All destination buffers locked by the application

•Release locked destination memory

•Allocate more destination memory

•Reduce the frame rate so that there is more time to process the filled destination memory

IS_CAP_STATUS_DRV_OUT_OF_BUFFERS

No free internal image memory is available to the driver. The image was discarded.

The computer takes too long to process the images in the uEye API (e.g. color conversion)

•Reduce the frame rate so that there is more time to process the filled image memory of the driver

•Disable resource-intensive API image pre-processing functions (e.g. edge enhancement, color correction, choose smaller filter mask for software color conversion)

IS_CAP_STATUS_DRV_DEVICE_NOT_READY

The camera is no longer available. It is not possible to access images that have already been transferred.

The camera has been disconnected or closed.

IS_CAP_STATUS_USB_TRANSFER_FAILED

The image was not transferred over the USB bus.

Not enough free bandwidth on the USB bus for transferring the image

•Reduce the pixel clock frequency

•Operate fewer cameras simultaneously on a USB bus

•Check the quality of the USB cabling and components

IS_CAP_STATUS_DEV_TIMEOUT

The maximum allowable time for image capturing in the camera was exceeded.

The selected timeout value is too low for image capture

•Reduce the exposure time

•Increase the timeout

IS_CAP_STATUS_ETH_BUFFER_OVERRUN

The sensor transfers more data than the internal camera memory of the GigE uEye can accommodate.

The selected data rate of the sensor is too high

•Reduce the pixel clock frequency

•Reduce the frame rate

•Reduce the image size

IS_CAP_STATUS_ETH_MISSED_IMAGES

Freerun mode: The GigE uEye camera could neither process nor output an image captured by the sensor.

Hardware trigger mode: The GigE uEye camera received a hardware trigger signal which could not be processed because the sensor was still busy.

The camera's frame rate is too high or the bandwidth on the network is insufficient to transfer the image

•Reduce the frame rate

•Increase the value for the receive descriptors in the network card settings

Contents of the UEYE_CAPTURE_STATUS_INFO structure

DWORD	dwCapStatusCnt_Total	Returns the total number of errors occurred since the last reset.
BYTE	reserved[60]	Reserved for an internal function
DWORD	adwCapStatusCnt_Detail[256]	This array returns the current count for each possible error. The possible errors are listed above.

Return values

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_NO_SUCCESS	General error message
IS_SUCCESS	Function executed successfully

Related functions

•is_GetError()

•is_CameraStatus()

•is_SetErrorReport()

Example 1

UEYE_CAPTURE_STATUS_INFO CaptureStatusInfo;

INT nRet = is_CaptureStatus(m_hCam,

IS_CAPTURE_STATUS_INFO_CMD_GET,

(void*)&CaptureStatusInfo,

sizeof(CaptureStatusInfo));

if (nRet == IS_SUCCESS)

{

UINT nConversionFailed = CaptureStatusInfo.adwCapStatusCnt_Detail[IS_CAP_STATUS_API_CONVERSION_FAILED]);

UINT nTotalInfos = CaptureStatusInfo.dwCapStatusCnt_Total;

}

Example 2

INT nRet = is_CaptureStatus(m_hCam,

IS_CAPTURE_STATUS_INFO_CMD_RESET,

NULL,

0);

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > C: Programming > Function descriptions >	History back Previous chapter Next chapter Print
is_CaptureStatus