IMAQdxGetImage

Format

rval = IMAQdxGetImage (IMAQdxSession id, Image *image, IMAQdxBufferNumberMode mode, unsigned int desiredBufferNumber, unsigned int *actualBufferNumber);

Purpose

Acquires the specified frame into image. Call this function only after calling IMAQdxConfigureAcquisition. If the image type does not match the video format of the camera, the function changes the image type to a suitable format.

Parameters

Parameter	Type	Description
id	IMAQdxSession	A valid Session ID, which you can obtain using IMAQdxOpenCamera.
image	Image *	The image that receives the captured pixel data.
mode	IMAQdxBufferNumberMode	The buffer number mode of the image to retrieve. Set this parameter to IMAQdxBufferNumberModeNext to get the next buffer, or set this parameter to IMAQdxBufferNumberLast to get the last acquired buffer, or set this parameter IMAQdxBufferNumberModeBufferNumber to acquire a specific cumulative buffer number.
desiredBufferNumber	unsigned int	The cumulative buffer number of the image to retrieve. This parameter is only needed if mode is set to IMAQdxBufferNumberModeBufferNumber.
actualBufferNumber	unsigned int (passed by reference)	On return, the actual cumulative buffer number of the image retrieved.

Return Value

On success, this function returns IMAQdxErrorSuccess. On failure, this function returns an error code. You can obtain a more detailed error message with IMAQdxGetErrorString.