imaqSetReferenceChar

NI Vision for LabWindows/CVI Function

imaqSetReferenceChar

Usage

int imaqSetReferenceChar(const CharSet* set, int index, int isReferenceChar);

Purpose

Sets a character as the reference character for the character class. If the character class already has a reference character, the new character will replace the old character as the reference character.

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 character to set as the reference character for its character class.
isReferenceChar int Set this parameter to TRUE to set the character as the reference character. Set this parameter to FALSE to unset the character as the reference character.

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