ClientFileEntryFileType Property

Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .

Syntax

 sftpserver.getClientFileEntryFileType([callback])
 sftpserver.setClientFileEntryFileType( clientFileEntryFileType, [callback])

Possible Values

  0 (cftFile), 
  1 (cftDirectory), 
  2 (cftSymblink), 
  3 (cftSpecial), 
  4 (cftUnknown), 
  5 (cftSocket), 
  6 (cftCharDevice), 
  7 (cftBlockDevice), 
  8 (cftFIFO)

Default Value

4

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 getClientFileEntryFileType([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 setClientFileEntryFileType([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

Specifies the type of this entry, one of the following:

This property is not available at design time.

Data Type

Integer