set_abort_time

Specifies the length of time in seconds to delay processing if the scan action encounters an unrecoverable error and sets the batch status to aborted.

Member of namespace

mvscan

Syntax

bool set_abort_time (int nSecs)

Parameters

nSecs: Type: int; Time to wait before continuing when a serious error occurs.

Parameters

nSecs : Time to wait before continuing when a serious error occurs.

Returns

Always True.

Level

Batch level.

Details

The scan action waits the specified time before returning if a fatal error is detected that would cause the batch to abort. This action can be useful to prevent a large number of aborted batches due to an abort condition. For example, if the source folder should become unavailable for some time, the abort timeout will limit the number of aborted batches until the folder becomes available again.

This delay restricts the number of aborted batches if the problem persists.

If this action is not called, the default abort time value of 5 seconds is used.

Example:

set_abort_time("60")
scan()