ExportToMemory Method of the Batch Object

This method saves results of the specified documents processing into memory, presented as a virtual file system. You can save the results from all the documents of the batch or specify particular documents to export results from. Use the ExportParams object to set the export settings. However, the values of the RootPath property of the FileExportParams object and the Path property of the ImageExportParams object are always ignored. Instead, the Export directory and Images directory relative to the root of the virtual file system will be used as the folders for output files. You can have other subfolders inside the Export and Images directories, which are defined by the FileNamePattern property of the FileExportParams object and the Prefix property of the ImageExportParams object.

Note that you can configure multiple export profiles (a set of settings that determines what is done with processed data) with the help of the IExportProfiles::AddNew method, in which case all appropriate export profiles for export to memory are used in turn.

Note: Only export profiles with the EDT_File value (export to file) of the DestinationType property is supported for exporting to memory. Export profiles with another destination value are ignored.

Syntax

Visual Basic .NET

Sub ExportToMemory( _
  DocIds As IntsCollection, _
  Params As ExportParams _
) As VirtualFileSystemNode
    

C++

HRESULT ExportToMemory(
  IIntsCollection* DocIds,
  IExportParams*   Params,
  IVirtualFileSystemNode** Result
);
    

Parameters

DocIds
[in] This parameter refers to the IntsCollection object that contains a set of identifiers of the documents to export results from. This parameter may be 0, in which case export is performed for all the documents of the batch.
Params
[in] This parameter refers to the ExportParams object that contains parameters of export. This parameter may be 0, in which case for each document the export parameters of the corresponding Document Definition are used.
Note: If there is no corresponding Document Definition, the export parameters of the IBatchTypeParams::ExportParamsForUnknownDocuments property are used. If there is no batch type, the export parameters of the IProjectProperties::ExportParamsForUnknownDocuments property are used.
Result
[out, retval] A pointer to the IVirtualFileSystemNode* object that receives the results of the exported documents.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FlexiCapture SDK functions.

Samples

See the following code sample: ExportToMemory

See also

Batch

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.