TScSFTPFileOpenFlag

Unit

ScSFTPUtils

type

TScSFTPFileOpenFlag = (ofAppendData, ofAppendDataAtomic, ofTextMode, ofNoFollow, ofDeleteOnClose, ofAccessAudit, ofAccessBackup, ofBackupStream, ofOverrideOwner);

TScSFTPFileOpenFlags = set of TScSFTPFileOpenFlag;

Description

The TScSFTPFileOpenFlag enumeration represents set of flags for file opening.

Value

Meaning

ofAppendData

data is always written at the end of the file. The offset parameter of the TScSFTPClient.WriteFile method is ignored.

ofAppendDataAtomic

data is always written at the end of the file. The offset parameter of the TScSFTPClient.WriteFile method is ignored. Data will be written atomically so that there is no chance that multiple appenders can collide and result in data being lost.

ofTextMode

Indicates that the server should treat the file as text and convert it to the canonical newline convention in use (refer to TScSFTPServerProperties.Newline). When a file is opened with this flag, the offset field in the read and write functions is ignored. To support seeks on text files you can use the TScSFTPClient.TextSeek method.

ofNoFollow

if the final component of the path is a symlink, then the opening will fail, and the error SSH_FX_LINK_LOOP will be returned.

ofDeleteOnClose

the file should be deleted when the last handle to it is closed. (The last handle may not be an sftp-handle.) This MAY be emulated by the server if the OS doesn't support it by deleting the file when this handle is closed.

ofAccessAudit

The client wants the server to enable any privileges or extra capabilities that the user may have to allow the reading and writing of AUDIT or ALARM access control entries.

ofAccessBackup

The client wants the server to enable any privileges or extra capabilities that the user may have in order to bypass normal access checks for the purpose of backing up or restoring files.

ofBackupStream

This flag indicates that the client wishes to read or write a backup stream. A backup stream is a system dependent structured data stream that encodes all information that must be preserved in order to restore the file from backup medium.

ofOverrideOwner

This flag indicates that the client wishes the server to enable any privileges or extra capabilities that the user may have in order to gain access to the file with the WRITE_OWNER permission. This bit must always be specified in combination with TScSFTPDesiredAccessItem.amWriteOwner.