HotFolderProfile Object (IHotFolderProfile Interface)

This object represents a hot folder import profile. Import profiles are created for convenience and to streamline the work. They allow you to select the import source and configure settings easily.

Properties

Name Type Description
CheckPeriod Integer Specifies the time interval in seconds for checking the hot folder for new images.
CreateNewBatches Boolean Specifies if new batches for the images should be created. If the value of this property is FALSE, the images will be added to an existing batch.
DeleteProcessedImages Boolean Specifies if the processed images should be deleted. If the value of this property is FALSE, the images are moved to the folder specified by the ProcessedImagesFolder property.
ExceptionsFolder String Specifies the path to the folder for invalid images (for example, images in unsupported format).
InputFolder String Specifies the path to the hot folder.
ImageImportParams ImageImportParams, read-only Specifies the parameters of images import.
MaximumImagesPerBatch Integer Specifies the maximum number of images in the newly created batch. The property is only available if the CreateNewBatches property is set to TRUE.
MaximumWaitPeriod Integer Specifies the maximum time interval in seconds after which a new batch will be created.
MinimumImagesPerBatch Integer Specifies the minimum number of images in the newly created batch. The property is only available if the CreateNewBatches property is set to TRUE.
ProcessedImagesFolder String Specifies the path to the folder for processed images.

Related objects

Output parameter

This object is the output parameter of the Item, AddNew methods of the HotFolderProfiles object.

See also

HotFolderProfiles

Working with Properties

8/15/2023 1:19:30 PM

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.