FileAttributeBits Property

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server.

Syntax

 sftp.getFileAttributeBits([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 getFileAttributeBits([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 setFileAttributeBits([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

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This property can have one or more of the following values OR'd together:

0x00000001 (SSH_FILEXFER_ATTR_FLAGS_READONLY)
0x00000002 (SSH_FILEXFER_ATTR_FLAGS_SYSTEM)
0x00000004 (SSH_FILEXFER_ATTR_FLAGS_HIDDEN)
0x00000008 (SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE)
0x00000010 (SSH_FILEXFER_ATTR_FLAGS_ARCHIVE)
0x00000020 (SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED)
0x00000040 (SSH_FILEXFER_ATTR_FLAGS_COMPRESSED)
0x00000080 (SSH_FILEXFER_ATTR_FLAGS_SPARSE)
0x00000100 (SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY)
0x00000200 (SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE)
0x00000400 (SSH_FILEXFER_ATTR_FLAGS_SYNC)
0x00000800 (SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR)

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

Data Type

Integer