imaqSnap

NI Vision for LabWindows/CVI Function

imaqSnap

Usage

Image* imaqSnap(SESSION_ID sessionID, Image* image, Rect rect);

Purpose

Acquires a single image.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL

Parameters

Name

Type

Description

sessionID SESSION_ID A valid session ID.
image Image* The image into which to acquire. If image is NULL, imaqSnap() creates a new image.
rect Rect The area to acquire. Set this parameter to IMAQ_NO_RECT to acquire the entire acquisition window.

Return Value

Type

Description

Image* On success, this function returns the acquired image. If you set image to NULL, the function returns a new image. Otherwise, the function returns a pointer to image. On failure, this function returns NULL. To get extended error information, call imaqGetLastError().