imaqWriteCustomData

NI Vision for LabWindows/CVI Function

imaqWriteCustomData

Usage

int imaqWriteCustomData(Image* image, const char* key, const void* data, unsigned int size);

Purpose

Associates some data with a text key in 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 Image* The image in which to write the custom data.
key const char* The key used to find the data in the image. This parameter is required and cannot be NULL.
data const void* The data associated with the key. This parameter is required and cannot be NULL.
size unsigned int Size of the data, in bytes.

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().