TElSftpFileAttributes.AttribBits property

TElSftpFileAttributes.AttribBits

TElSftpFileAttributes See also

Filter: C# VB.NET Pascal C++ PHP Java

This field, taken together with AttribBitsValid, reflect various attributes of the file or directory, on the server.

Declaration

[C#]
uint AttribBits;

[VB.NET]
Property AttribBits As UInt32

[Pascal]
property AttribBits : Cardinal;

[C++]
uint32_t get_AttribBits();
void set_AttribBits(uint32_t Value);

[PHP]
integer get_AttribBits()
void set_AttribBits(integer $Value)

[Java]
int getAttribBits();
void setAttribBits(int Value);

Values:

Definition	Value	Description
SSH_FILEXFER_ATTR_FLAGS_READONLY	1 (0x0001)	Advisory, read-only bit.This bit is not part of the access control information on the file,but is rather an advisory field indicating that the file should not be written
SSH_FILEXFER_ATTR_FLAGS_SYSTEM	2 (0x0002)	The file is part of the operating system
SSH_FILEXFER_ATTR_FLAGS_HIDDEN	4 (0x0004)	File SHOULD NOT be shown to user unless specifically requested.For example, most UNIX systems SHOULD set this bit ifthe filename begins with a ‘period’.This bit may be read-only.Most UNIX systems will not allow this to be changed
SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE	8 (0x0008)	This attribute applies only to directories.This attribute is always read-only, and cannot be modified.This attribute means that files and directory names in this directoryshould be compared without regard to case.Unless otherwise specified, filenames are assumed to be case sensitive
SSH_FILEXFER_ATTR_FLAGS_ARCHIVE	16 (0x0010)	The file should be included in backup / archive operations
SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED	32 (0x0020)	The file is stored on disk using file-system level transparent encryption.This flag does not affect the file data on the wire (for either READ or WRITE requests)
SSH_FILEXFER_ATTR_FLAGS_COMPRESSED	64 (0x0040)	The file is stored on disk using file-system level transparent compression.This flag does not affect the file data on the wire
SSH_FILEXFER_ATTR_FLAGS_SPARSE	128 (0x0080)	The file is a sparse file; this means that file blocks that have not been explicitly written are not stored on disk. For example, if a client writes a buffer at 10 M from the beginning of the file, the blocks between the previous EOF marker and the 10 M offset would not consume physical disk space. Some servers may store all files as sparse files, in which case this bit will be unconditionally set. Other servers may not have a mechanism for determining if the file is sparse, and so the file MAY be stored sparse even if this flag is not set
SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY	256 (0x0100)	Opening the file without either the SSH_FXF_ACCESS_APPEND_DATA orthe SSH_FXF_ACCESS_APPEND_DATA_ATOMIC flag MUST result in an SSH_FX_INVALID_PARAMETER error
SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE	512 (0x0200)	The file cannot be deleted or renamed, no hard link can be created to this file, and no data can be written to the file. This bit implies a stronger level of protection than SSH_FILEXFER_ATTR_FLAGS_READONLY, the file permission mask or ACLs. Typically even the superuser cannot write to immutable files, and only the superuser can set or remove the bit
SSH_FILEXFER_ATTR_FLAGS_SYNC	1024 (0x0400)	When the file is modified, the changes are written synchronously to the disk
SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR	2048 (0x0800)	The server MAY include this bit in a directory listing or realpath response.It indicates there was a failure in the translation to UTF-8.If this flag is included, the server SHOULD also include the UNTRANSLATED_NAME attribute

Description

Bits not set in AttribBitsValid are ignored. This allows both the server and the client to communicate only the bits it knows about without inadvertently twiddling bits they don't understand.
This feature is supported since version 5 of the SFTP protocol.