imaqRenameChar

NI Vision for LabWindows/CVI Function

imaqRenameChar

Usage

int imaqRenameChar(CharSet* set, int index, const char* newCharValue);

Purpose

Renames a trained character.

Parameters

Name

Type

Description

set CharSet* The character set this function operates on. To create a character set, use imaqCreateCharSet(). This parameter is required and cannot be NULL.
index int The index of a character to rename.
newCharValue const char* The new character value that you want to assign to the character. The length of this string must not exceed 255 characters.

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