SaveToTextFile Method of the PlainText Object

SaveToTextFile method of the PlainText Object in the ABBYY FineReader Engine API — Saves the recognized text from the PlainText object to a text file with the specified encoding (TextEncodingTypeEnum).

This method saves the recognized text from the PlainText object into a text file with the specified encoding.

Syntax

C++

HRESULT SaveToTextFile(
  BSTR                 Path,
  TextEncodingTypeEnum encodingType,
  CodePageEnum         codePageEnum
);

C#

void SaveToTextFile(
  string               Path,
  TextEncodingTypeEnum encodingType,
  CodePageEnum         codePageEnum
);

Visual Basic .NET

Sub SaveToTextFile( _
  Path As String, _
  encodingType As TextEncodingTypeEnum, _
  codePageEnum As CodePageEnum _
)

Parameters

Path

[in] A string containing the full path to the file where the text should be saved. If this file does not exist, it will be created. If it exists, it will be overwritten without prompt.

encodingType

[in] Specifies the text encoding type. It may be set to one of the constants from the TextEncodingTypeEnum enumeration.

codePageEnum

[in] Specifies the code page. It may be set to one of the constants from the CodePageEnum enumeration. The value of this parameter is taken into account only when the encodingType parameter has value TET_Simple (exported text is not Unicode). If this property does not specify any code page (CP_Null), the code page is selected automatically.

Return values

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

See also

PlainText