CreateEmptyUserPattern Method of the Engine Object

CreateEmptyUserPattern method of the Engine Object in the ABBYY FineReader Engine API — This method creates an empty user pattern file (*.ptn) at the specified location.

This method creates an empty user pattern file (*.ptn) at the specified location.

Syntax

C++

HRESULT CreateEmptyUserPattern( BSTR FileName );

C#

void CreateEmptyUserPattern( string FileName );

Visual Basic .NET

Sub CreateEmptyUserPattern(FileName As String)

Parameters

FileName

[in] This variable contains the full path to the newly created user pattern file,

• Windows: C:\pattern.ptn
• Linux: /home/user/Documents/Patterns/pattern.ptn
• macOS: /Users/user/Documents/pattern.ptn

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

Remarks

• User patterns are files that specify a number of pairs “image of a character — the character itself”. User patterns may be used during recognition to identify characters of non-standard fonts. To use a user pattern during recognition, specify a path to it in the IRecognizerParams::UserPatternsFile property.
  • For Linux, user patterns may be trained using the TrainUserPattern method of the Engine object.
  • For Windows, user patterns may be edited via the IEngine::EditUserPattern method or trained during recognition. See Recognizing with Training.
• The method is enabled only if the license supports the User Patterns Training module.
• Pattern training is not supported for CJK languages.

See also

Recognizing with Training

Engine

EditUserPattern