imaqReadOCRFile

NI Vision for LabWindows/CVI Function

imaqReadOCRFile

Usage

int imaqReadOCRFile(const char* fileName, CharSet* set, String255 setDescription, ReadTextOptions* readOptions, OCRProcessingOptions* processingOptions, OCRSpacingOptions* spacingOptions);

Purpose

Reads a character set and the appropriate NI Vision structures from the file specified by fileName.

Parameters

Name

Type

Description

fileName const char* File that the function uses for this operation. This parameter is required and cannot be NULL.
set CharSet* The character set the function operates on. To create a character set use imaqCreateCharSet(). If the character set already contains trained characters, the function appends the trained characters from the file to the existing trained characters. Set this parameter to NULL if you do not need this information.
setDescription String255 On return, the description of the character set contained in the file. Set this parameter to NULL if you do not need this information.
readOptions ReadTextOptions* On return, the options used to read text contained in the file. Set this parameter to NULL if you do not need this information.
processingOptions OCRProcessingOptions* On return, the image processing options contained in the file. Set this parameter to NULL if you do not need this information.
spacingOptions OCRSpacingOptions* On return, the character size spacing options contained in the file. Set this parameter to NULL if you do not need this information.

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