imaqRemoveCustomData

NI Vision for LabWindows/CVI Function

imaqRemoveCustomData

Usage

int imaqRemoveCustomData(Image* image, const char* key);

Purpose

Removes a custom data key and its associated data from 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 to remove the custom data from.
key const char* The key to remove from the image.

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