FileType Property

The type of file.

Syntax

 sftp.getFileType([callback])

Possible Values

  1 (sftRegular), 
  2 (sftDirectory), 
  3 (sftSymLink), 
  4 (sftSpecial), 
  5 (sftUnknown), 
  6 (sftSocket), 
  7 (sftCharDevice), 
  8 (sftBlockDevice), 
  9 (sftFIFO)

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 getFileType([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 setFileType([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

The type of file. FileType may be one of the following values:


1 (sftRegular - default)	A normal file.
2 (sftDirectory)	A directory.
3 (symlink)	The file is a Unix symbolic link.
4 (sftSpecial)	The file type is a special system file.
5 (sftUnknown)	The file type is unknown.
6 (sftSocket)	The file handle is a socket handle.
7 (sftCharDevice)	The file handle is a character input device.
8 (sftBlockDevice)	The file handle is a block input device.
9 (sftpFIFO)	The file handle is a buffering input device.

This property is read-only and not available at design time.

Data Type

Integer