AddImages Method of the Batch Object

This method adds specified images to the batch. The method creates documents in the batch for added images.

Syntax

Visual Basic .NET

Sub AddImages( _
  Files As StringsCollection, _
  DocID As Integer, _
  LoadingParams As ImageLoadingParams, _
  GroupingParams As ImageGroupingParams, _
  PasswordProtectedPdf As StringsCollection, _
  DocIds As IntsCollection _
)
    

C++

HRESULT AddImages(
  IStringsCollection*   Files,
  int                   DocID,
  IImageLoadingParams*  LoadingParams,
  IImageGroupingParams* GroupingParams,
  IStringsCollection**  PasswordProtectedPdf,
  IIntsCollection**     DocIds
);
    

Parameters

Files
[in] This parameter refers to the StringsCollection object which contains a collection of paths to the files to be added.
DocID
[in] This parameter specifies the identifier of the document in the batch. The created documents will be inserted into the collection of batch documents after the document with the specified identifier. This parameter may be set to -1, in which case the documents will be added at the end of the batch.
LoadingParams
[in] This variable refers to the ImageLoadingParams object that stores parameters of image preparation during adding to the batch. This parameter may be 0. In this case the images are added using the parameters set in the project properties (the IProjectProperties::ImageLoadingParams property).
GroupingParams
[in] This variable refers to the ImageGroupingParams object that stores parameters that determine the principles of adding images to documents. This parameter may be 0. In this case the images are added using the parameters set in project properties in ABBYY FlexiCapture.
PasswordProtectedPdf
[in, out] A pointer to the IStringsCollection* variable that receives the interface pointer for the collection of paths to the files which were not added, because they are password-protected and cannot be opened (possible only for input files in PDF format).
DocIds
[in, out] A pointer to the IIntsCollection* variable that receives the interface pointer for the list of identifiers of the added documents.

Return values

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

Remarks

  • To add one image to the batch, you can use the AddImage method of the Batch object.
  • You may also use this method to open digital documents of supported formats.

Samples

C++ (COM) code

This object is used in the following code samples: Classification.

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.