SFtpFile Delphi DLL Reference Documentation

SFtpFile

Represents a remote SFTP file.

Create/Dispose

function CkSFtpFile_Create: HCkSFtpFile; stdcall;

Creates an instance of the HCkSFtpFile object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkSFtpFile_Dispose(handle: HCkSFtpFile); stdcall;

Objects created by calling CkSFtpFile_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

procedure CkSFtpFile_getCreateTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__createTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;

The same as the CreateTime property, but returns the date/time as an RFC822 formatted string.

procedure CkSFtpFile_getFileType(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__fileType(objHandle: HCkSFtpFile): PWideChar; stdcall;

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

procedure CkSFtpFile_getFilename(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__filename(objHandle: HCkSFtpFile): PWideChar; stdcall;

The filename (or directory name, symbolic link name, etc.)

function CkSFtpFile_getGid(objHandle: HCkSFtpFile): Integer; stdcall;

The integer Group ID of the file.

procedure CkSFtpFile_getGroup(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__group(objHandle: HCkSFtpFile): PWideChar; stdcall;

The group ownership of the file. This property is only supported by servers running SFTP v4 or later.

function CkSFtpFile_getIsAppendOnly(objHandle: HCkSFtpFile): wordbool; stdcall;

If True, this file may only be appended. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsArchive(objHandle: HCkSFtpFile): wordbool; stdcall;

If True, the file should be included in backup / archive operations. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsCaseInsensitive(objHandle: HCkSFtpFile): wordbool; stdcall;

This attribute applies only to directories. This attribute means that files and directory names in this directory should be compared without regard to case. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsCompressed(objHandle: HCkSFtpFile): wordbool; stdcall;

The file is stored on disk using file-system level transparent compression. This flag does not affect the file data on the wire. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsDirectory(objHandle: HCkSFtpFile): wordbool; stdcall;

If True, this is a directory.

function CkSFtpFile_getIsEncrypted(objHandle: HCkSFtpFile): wordbool; stdcall;

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.) This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsHidden(objHandle: HCkSFtpFile): wordbool; stdcall;

If True, the file SHOULD NOT be shown to user unless specifically requested.

function CkSFtpFile_getIsImmutable(objHandle: HCkSFtpFile): wordbool; stdcall;

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 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.

This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsReadOnly(objHandle: HCkSFtpFile): wordbool; stdcall;

If True, the file is read-only. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsRegular(objHandle: HCkSFtpFile): wordbool; stdcall;

True if this is a normal file (not a directory or any of the other non-file types).

function CkSFtpFile_getIsSparse(objHandle: HCkSFtpFile): wordbool; stdcall;

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.

This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsSymLink(objHandle: HCkSFtpFile): wordbool; stdcall;

True if this is a symbolic link.

function CkSFtpFile_getIsSync(objHandle: HCkSFtpFile): wordbool; stdcall;

When the file is modified, the changes are written synchronously to the disk. This property is only supported by servers running SFTP v6 or later.

function CkSFtpFile_getIsSystem(objHandle: HCkSFtpFile): wordbool; stdcall;

True if the file is part of the operating system. This property is only supported by servers running SFTP v6 or later.

procedure CkSFtpFile_getLastAccessTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__lastAccessTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;

The same as the LastAccessTime property, but returns the date/time as an RFC822 formatted string.

procedure CkSFtpFile_getLastModifiedTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__lastModifiedTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;

The same as the LastModifiedTime property, but returns the date/time as an RFC822 formatted string.

procedure CkSFtpFile_getOwner(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__owner(objHandle: HCkSFtpFile): PWideChar; stdcall;

The owner of the file. This property is only supported by servers running SFTP v4 or later.

function CkSFtpFile_getPermissions(objHandle: HCkSFtpFile): Integer; stdcall;

The 'permissions' field contains a bit mask specifying file permissions. These permissions correspond to the st_mode field of the stat structure defined by POSIX [IEEE.1003-1.1996].

This protocol uses the following values for the symbols declared in the POSIX standard.

       S_IRUSR  0000400 (octal)
       S_IWUSR  0000200
       S_IXUSR  0000100
       S_IRGRP  0000040
       S_IWGRP  0000020
       S_IXGRP  0000010
       S_IROTH  0000004
       S_IWOTH  0000002
       S_IXOTH  0000001
       S_ISUID  0004000
       S_ISGID  0002000
       S_ISVTX  0001000

function CkSFtpFile_getSize32(objHandle: HCkSFtpFile): Integer; stdcall;

Size of the file in bytes. If the size is too large for 32-bits, a -1 is returned.

function CkSFtpFile_getSize64(objHandle: HCkSFtpFile): Int64; stdcall;

Size of the file in bytes. If the file size is a number too large for 64 bits, you have an AMAZINGLY large disk drive.

procedure CkSFtpFile_getSizeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;

function CkSFtpFile__sizeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;

Same as Size64, but the number is returned as a string in decimal format.

function CkSFtpFile_getUid(objHandle: HCkSFtpFile): Integer; stdcall;

The integer User ID of the file.

Methods

function CkSFtpFile_GetCreateDt(objHandle: HCkSFtpFile): HCkDateTime; stdcall;

Returns the file creation date and time (GMT / UTC). This method is only supported by servers running SFTP v4 or later.

function CkSFtpFile_GetLastAccessDt(objHandle: HCkSFtpFile): HCkDateTime; stdcall;

Returns the last-access date and time (GMT / UTC).

function CkSFtpFile_GetLastModifiedDt(objHandle: HCkSFtpFile): HCkDateTime; stdcall;

Returns the last-modified date and time (GMT / UTC).