TransferMode Property

The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.

Syntax

 ftp.getTransferMode([callback])
 ftp.setTransferMode( transferMode, [callback])

Possible Values

  0 (tmDefault), 
  1 (tmASCII), 
  2 (tmBinary)

Default Value

0

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 getTransferMode([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 setTransferMode([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

This property specifies the transfer mode, either ASCII or binary. The valid options for the TransferMode property are as follows:

Data Type

Integer