imaqEnumerateCustomKeys

NI Vision for LabWindows/CVI Function

imaqEnumerateCustomKeys

Usage

char** imaqEnumerateCustomKeys(const Image* image, unsigned int* size);

Purpose

Finds all the custom data keys associated with an image.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_RGB_U64

Parameters

Name

Type

Description

image const Image* The image from which to enumerate data keys.
size unsigned int* The number of keys found in the image.

Return Value

Type

Description

char** This function returns an array containing a number of strings equal to the value returned in the size parameter. Each string is the key to one custom data item available in the image.