SaveToFile Method of the ImageDocument Object

SaveToFile method of the ImageDocument Object in the ABBYY FineReader Engine API — Saves the ImageDocument contents to a file in an internal format readable only via IEngine.LoadImageDocFromFile.

This method saves the contents of the ImageDocument object into a file. The file is saved in a format which cannot be viewed in any external program. The ImageDocument object saved using this method can be opened with the help of the IEngine::LoadImageDocFromFile method only.

Syntax

C++

HRESULT SaveToFile( BSTR FileName );

C#

void SaveToFile( string FileName );

Visual Basic .NET

Sub SaveToFile(FileName As String)

Parameters

FileName

[in] This parameter stores the full path to the file. For example, /Users/user/Documents/MyPic.imageDoc, /home/user/Pictures/MyPic.imageDoc, C:\MyPic.imageDoc. If this file already exists, it is overwritten without prompt.

Return values

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

Remarks

This method is not suitable for saving images, as it saves the contents of the ImageDocument object in a format not suitable for viewing. It is designed for situations when it is not possible to use the IImageDocument::SaveTo method which saves the object’s contents into a folder on disk.

To save an image in a format suitable for viewing, use the IImage::WriteToFile method.

See also

ImageDocument

IEngine::LoadImageDocFromFile