SetAbortTimeout

Sets the amount of time to wait before you stop running a batch.

Member of namespace

OpenTextFaxServer

Syntax

bool SetAbortTimeout (int Milliseconds)

Parameters

Milliseconds: Type: int

Parameters

Milliseconds : The amount of time, in milliseconds, to wait before aborting a batch. The default value is 10000 ms (10 seconds).

Returns

False if the action is not called at the batch level. Otherwise, True.

Level

Batch Level.

Details

Sets the amount of time to wait before aborting a batch.

The action waits the specified time before returning when an abort occurs. This action can be useful to prevent a large number of aborted batches due to an abort condition. For example, if the fax server should become unavailable for a time, the abort timeout will limit the amount of aborted batches until the fax server becomes available again.

If this action is not called, the default value of 10 seconds is used.

Include this action before a ImportFaxes() action.

Example

SetServerName("myserver")
SetUserID("myuser")
SetUserPassword("mypassword")
SetProtocol(4)
SetAbortTimeout(5000)
Connect()
ImportFaxes()