FTPTimeout Property

A timeout to use when uploading via FTP.

Syntax

 check21.getFTPTimeout([callback])
 check21.setFTPTimeout( FTPTimeout, [callback])

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getFTPTimeout([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setFTPTimeout([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

A timeout to use when uploading via FTP.

When uploading the X9.37 file to the FTP FTPRemoteHost, the class will use this property to determine how long to wait for the operation to complete before returning control. The FTPTimeout property cannot be set to 0

The default value for the Timeout property is 60 (seconds).

This property is not available at design time.

Data Type

Integer