VCEANCB_Prepare

ImperX VCEANCB Functions

VCEANCB_Prepare

The VCEANCB_Prepare function prepares FrameLink card to snap one frame from camera.

VCEANCB_Error VCEANCB_Prepare (
  HANDLE hVCEANCB, // Handle to card
  VCEANCB_CameraConfig* pCameraConfig // Data to prepare
);

Parameter:

hVCEANCB
[in] Handle to FrameGrabber.
pCameraConfig
[in] Pointer to a VCEANCB_CameraConfig structure.

Return values:

If function succeeds, the return value is VCEANCB_Err_Success.

If function fails, the return value can be one of the following values.

VCEANCB_Err_badArgument hVCEANCB handle or pCameraConfig pointer is bad (possibly NULL).
VCEANCB_Err_notInitialized FrameLink has not been successfully initialized.
VCEANCB_Err_bufferBusy One of snapping buffers is busy.
VCEANCB_Err_UnknownError Error is unknown (possibly system error). To get extended error information, call VCEANCB_SystemLastError.

Remarks:

This function deletes all snapping buffer and sends configuration command to FrameLink card. Note: Use this function only if you would like to use VCEANCB_SnapFrame() function.
If you would like to use stream grabbing function VCEANCB_StartGrab you need to call VCEANCB_PrepareGrab() function.

See also:

VCEANCB_CameraConfig, VCEANCB_SnapFrame, VCEANCB_PrepareGrab