SetSourceDirectory

Syntax

bool SetSourceDirectory (SmartParam)

Parameters

String value of the directory's name and path. Instead, you can use a Smart Parameter, such as @APPPATH, to establish the name and path of the Source Directory.

Returns

False, if the parameter is blank or the directory does not exist. Otherwise, True.

If the source directory does not exist, the batch status is set to abort.

Level

Any level but usually the batch level.

Details

This action indicates the name and path of the directory that contains the Image files to be scanned.

This is a required action. A task that employs a vScan rule cannot process images unless it has this key locator. This action must be called before the scan action.

Example

In the folowing example, the full path to the images directory is coded directly into the application rules.

SetSourceDirectory("c:\ParentDirectory\Application\Images")  

In the following example, @APPPATH obtains the vscan directory from the application service. This makes the application more flexible because the same application that is installed in two different environments, such as test and production, can use two different input directories. The subdirectory Input is appended to the path.

SetSourceDirectory("@APPPATH(vscanimagedir)+\+Input")