imaqIsVisionInfoPresent

NI Vision for LabWindows/CVI Function

imaqIsVisionInfoPresent

Usage

int imaqIsVisionInfoPresent(const Image* image, VisionInfoType type, int* present);

Purpose

Retrieves whether the given image contains the requested Vision information.

Note  This function is obsolete. The replacement function is imaqGetVisionInfoTypes(), which retrieves all available types in one call. The new function also reveals more detailed information.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL

Parameters

Name

Type

Description

image const Image* The image that the function checks for the presence of Vision information.
type VisionInfoType The Vision information for which the function checks.
present int* On return, this parameter is TRUE if the Vision information specified by type is present in the image and FALSE if the information is not contained in the image. This parameter is required and cannot be NULL.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().