imaq1394SnapImage

NI-IMAQ for IEEE 1394 Cameras Function

imaq1394SnapImage

Format

rval = imaq1394SnapImage (SESSION_ID sessionId, Image *image, Rect rectangle);

Purpose

Configures, starts, acquires, stops, and unconfigures a snap acquisition. Use a snap for low-speed or single-capture applications where ease of programming is essential. If you call this function before calling imaq1394CameraOpen2, imaq1394SnapImage uses cam0 by default. If the image type does not match the video format of the camera, this 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.
image ImageĀ * The image into which to acquire. Use the IMAQ Vision function imaqCreateImage to create an image.
rectangle Rect The area to acquire. Set this parameter to IMAQ_NO_RECT to acquire the entire acquisition window.

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.