imaq1394GetImage2

Format

rval = imaq1394GetImage2 (SESSION_ID sessionID, unsigned long bufferNumberDesired, unsigned long *bufferNumberActual, unsigned long onOverwrite, Image *image);

Purpose

Acquires the specified frame into Image. Call this function only after calling imaq1394ConfigureAcquisition. 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
sessionId	SESSION_ID	A valid Session ID, which you can obtain using imaq1394CameraOpen2.
bufferNumberDesired	unsigned long	The cumulative buffer number of the image to retrieve. For continuous acquisitions, set this parameter to IMG1394_LASTBUFFER to get the next buffer, or set this parameter to IMG1394_IMMEDIATEBUFFER to get the current buffer.
bufferNumberActual	unsigned long *	On return, the actual cumulative buffer number of the image retrieved.
onOverwrite	unsigned long	The overwrite policy to follow if a buffer is overwritten during acquisition. Specify IMG1394_ONOVERWRITE_GET_OLDEST to get the oldest valid buffer instead of the overwritten buffer. Specify IMG1394_ONOVERWRITE_FAIL to return an error if the requested buffer is overwritten. Specify IMG1394_ONOVERWRITE_GET_NEWEST to get the most recent valid buffer instead of the overwritten buffer. Note  The IMG1394_ONOVERWRITE_GET_NEXT_ITERATION policy is not implemented by NI-IMAQ for IEEE 1394 Cameras and is only presented to keep the API consistent with NI-IMAQ 3.x.
Image	Image *	The buffer that contains the IMAQ Vision image when the function returns.

Return Value

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