imaqGetCharInfo

NI Vision for LabWindows/CVI Function

imaqGetCharInfo

Usage

CharInfo* imaqGetCharInfo(const CharSet* set, int index);

Purpose

Returns information about a particular trained character. The structure that the function returns contains a copy of the data from the character set. Modifications to the information in the structure do not affect the character set.

Note  This function is obsolete. The replacement function is imaqGetCharInfo2().

Parameters

Name

Type

Description

set const 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 trained character in the character set from which the function gets information.

Return Value

Type

Description

CharInfo* On success, this function returns a report that contains information about the character. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you finish with the character information, call imaqDispose() to dispose of it.