OFTPConnectionTimeout Property

A timeout for the component.

Syntax

__property int OFTPConnectionTimeout[int ConnectionId] = { read=FOFTPConnectionTimeout, write=FSetOFTPConnectionTimeout };

Default Value

0

Remarks

A timeout for the component.

If the OFTPConnectionTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If OFTPConnectionTimeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for OFTPConnectionTimeout is specified by the DefaultTimeout property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer