Open Method of the IFileWriter Interface

Open method of the IFileWriter Interface in the ABBYY FineReader Engine API — Client-side method that starts writing the specified file into memory; receives the file name and buffer size.

This method is implemented on the client-side. This method starts writing the specified file into memory.

Syntax

C++

HRESULT Open(
  BSTR FileName,
  int* BufferSize
);

C#

void Open(
  string  FileName,
  ref int BufferSize
);

Visual Basic .NET

Sub Open( _
  FileName As String, _
  ByRef BufferSize As Integer _
)

Parameters

FileName

[in] The name of the file to be written into memory.

BufferSize

[in, out] The limitation on the size of each continuously written portion of the file. This parameter is optional and can be 0, in which case the default portion size will be used and returned in this parameter.

Return values

[C++ only] If this method returns a value other than S_OK, this indicates that an error occurred on the client-side.

Remarks

The client implementation of this method must assure that all exceptions thrown inside the method are caught and handled and no exceptions are propagated outside the method. Propagation of an exception outside the method may lead to unpredictable results (such as program termination).

See also

IFileWriter