set_copy_folder

Member of namespace

Syntax

bool set_copy_folder (string folderpath)

Parameters

Smart parameters are supported.

folderpath

The folder, if any, to which the scan action copies files that it successfully ingested. Specify a full or relative folder path. If you specify a relative path, the path is relative to the root input folder. For information about the root input folder, see set_folder.

Here are the possible values:

Same as input folder	For demonstration purposes, you might want to set the copy folder to be the same as the input folder. In this case, ingested files are left in place.
Empty string	Ingested files are moved to the batch folder without making copies.
Any other folder	Ingested files are copied to the specified folder.

If you do not call this action, the scan action behaves by default the same as if you specified an empty string for the copy folder.

The location of the copy folder is affected by the mv_retain_folder action. For more information, see mv_retain_folder.

Returns

Level

Details

If the specified folder does not exist, the scan action generates an error.

This action must be called before scan() to take effect.

Example:

set_folder("@APPPATH(vscanimagedir)+@STRING(\input folder)")
set_copy_folder(@APPPATH(vscanimagedir)+@STRING(\copy folder))
scan()