set_tree_mode

Determines whether subdirectories are included in the scan for files to ingest.

Member of namespace

mvscan

Syntax

bool set_tree_mode (bool bTreeFlag)

Parameters

bTreeFlag
Type: bool

Parameters

bTreeFlag : A Boolean value that enables or disables ingesting files from sub-folders within the top-level scan folder.

True: Search for files in subfolders to any depth under the scan folder. This is the default if the action is not called.

False: Ingest files that are located in the scan folder only. Ignore subfolders.

Details

If tree mode is enabled, each batch contains files from only one folder. Files from multiple folders are never ingested into the same batch.

For this action to take effect, it must be called before the Scan action.

Example:
set_types("tif")
set_tree_mode(True)
scan()