---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: SFtpFile
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkSFtpFileRef.html
---
# Chilkat SFtpFile — Delphi DLL — v11.7.0

> Chilkat 11.7.0 · language=delphidll · class=SFtpFile
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/SFtpFile.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/guide.md`.

## Purpose

**Inspect metadata for a file, directory, symlink, or special item in an SFTP listing.**

`Chilkat.SFtpFile` represents one entry returned from an SFTP directory listing. It exposes the entry name, file type, size, ownership, permissions, timestamps, and server-provided attribute flags such as hidden, read-only, archive, immutable, encrypted, compressed, sparse, append-only, system, and synchronization status. It is typically used together with `Chilkat.SFtpDir` when iterating a remote directory and deciding how each entry should be displayed, filtered, downloaded, skipped, or processed.

**Name and type**

Read `Filename` and `FileType`, or use convenience flags such as `IsRegular`, `IsDirectory`, and `IsSymLink`.

**File sizes**

Access the entry size as a 32-bit integer, 64-bit integer, or decimal string using `Size32`, `Size64`, or `SizeStr`.

**Timestamps**

Inspect creation, last-access, and last-modified times as date/time values or RFC822-formatted strings when supported by the server.

**Ownership**

Read numeric user and group IDs, and when the server supports it, textual owner and group names.

**Permissions**

Inspect the POSIX-style permissions bit mask for read, write, execute, set-user-ID, set-group-ID, and sticky-bit information.

**Extended attributes**

Check server-provided flags such as hidden, read-only, archive, immutable, encrypted, compressed, sparse, append-only, system, and sync.

**Common pattern:** Retrieve a directory listing with `Chilkat.SFtp`, iterate its `Chilkat.SFtpDir` entries, and populate a `Chilkat.SFtpFile` object for each item. Use the file type, timestamps, size, permissions, and attribute flags to decide whether the entry is a regular file, directory, symlink, or special item and how the application should handle it.

**Server-version note:** Some metadata is only available from newer SFTP protocol versions. For example, textual owner/group information and creation time require SFTP v4 or later, while many extended attribute flags such as read-only, archive, immutable, compressed, encrypted, sparse, append-only, and system require SFTP v6 or later.

## Object creation, unlocking and error handling

**Create/Dispose**

```pascal
var
myObject: HCkSFtpFile;

begin
myObject := CkSFtpFile_Create();

// ...

CkSFtpFile_Dispose(myObject);
end;
```

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

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Delphi DLL.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `procedure CkSFtpFile_getDebugLogFilePath(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; procedure CkSFtpFile_putDebugLogFilePath(objHandle: HCkSFtpFile; newPropVal: PWideChar); stdcall; function CkSFtpFile__debugLogFilePath(objHandle: HCkSFtpFile): PWideChar; stdcall;` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `procedure CkSFtpFile_getLastErrorHtml(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__lastErrorHtml(objHandle: HCkSFtpFile): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkSFtpFile_getLastErrorText(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__lastErrorText(objHandle: HCkSFtpFile): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkSFtpFile_getLastErrorXml(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__lastErrorXml(objHandle: HCkSFtpFile): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkSFtpFile_getLastMethodSuccess(objHandle: HCkSFtpFile): wordbool; stdcall; procedure CkSFtpFile_putLastMethodSuccess(objHandle: HCkSFtpFile; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkSFtpFile_getVerboseLogging(objHandle: HCkSFtpFile): wordbool; stdcall; procedure CkSFtpFile_putVerboseLogging(objHandle: HCkSFtpFile; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkSFtpFile_getVersion(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__version(objHandle: HCkSFtpFile): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `CreateTimeStr` | property, read-only | `procedure CkSFtpFile_getCreateTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__createTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `Filename` | property, read-only | `procedure CkSFtpFile_getFilename(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__filename(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `FileType` | property, read-only | `procedure CkSFtpFile_getFileType(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__fileType(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `Gid` | property, read-only | `function CkSFtpFile_getGid(objHandle: HCkSFtpFile): Integer; stdcall;` |
| `Group` | property, read-only | `procedure CkSFtpFile_getGroup(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__group(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `IsAppendOnly` | property, read-only | `function CkSFtpFile_getIsAppendOnly(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsArchive` | property, read-only | `function CkSFtpFile_getIsArchive(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsCaseInsensitive` | property, read-only | `function CkSFtpFile_getIsCaseInsensitive(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsCompressed` | property, read-only | `function CkSFtpFile_getIsCompressed(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsDirectory` | property, read-only | `function CkSFtpFile_getIsDirectory(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsEncrypted` | property, read-only | `function CkSFtpFile_getIsEncrypted(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsHidden` | property, read-only | `function CkSFtpFile_getIsHidden(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsImmutable` | property, read-only | `function CkSFtpFile_getIsImmutable(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsReadOnly` | property, read-only | `function CkSFtpFile_getIsReadOnly(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsRegular` | property, read-only | `function CkSFtpFile_getIsRegular(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsSparse` | property, read-only | `function CkSFtpFile_getIsSparse(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsSymLink` | property, read-only | `function CkSFtpFile_getIsSymLink(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsSync` | property, read-only | `function CkSFtpFile_getIsSync(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `IsSystem` | property, read-only | `function CkSFtpFile_getIsSystem(objHandle: HCkSFtpFile): wordbool; stdcall;` |
| `LastAccessTimeStr` | property, read-only | `procedure CkSFtpFile_getLastAccessTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__lastAccessTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `LastModifiedTimeStr` | property, read-only | `procedure CkSFtpFile_getLastModifiedTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__lastModifiedTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `Owner` | property, read-only | `procedure CkSFtpFile_getOwner(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__owner(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `Permissions` | property, read-only | `function CkSFtpFile_getPermissions(objHandle: HCkSFtpFile): Integer; stdcall;` |
| `Size32` | property, read-only | `function CkSFtpFile_getSize32(objHandle: HCkSFtpFile): Integer; stdcall;` |
| `Size64` | property, read-only | `function CkSFtpFile_getSize64(objHandle: HCkSFtpFile): Int64; stdcall;` |
| `SizeStr` | property, read-only | `procedure CkSFtpFile_getSizeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall; function CkSFtpFile__sizeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;` |
| `Uid` | property, read-only | `function CkSFtpFile_getUid(objHandle: HCkSFtpFile): Integer; stdcall;` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### SFtpFile.CreateTimeStr

`Chilkat 11.7.0 · delphidll · SFtpFile · CreateTimeStr · property · read-only`

```pascal
procedure CkSFtpFile_getCreateTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__createTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the file creation date and time as an RFC 822-formatted string, such as `Fri, 21 Nov 1997 09:55:06 -0600`.

**Server requirement:** Creation-time metadata is available only when the server supports SFTP version 4 or later and provides this attribute.

### SFtpFile.Filename

`Chilkat 11.7.0 · delphidll · SFtpFile · Filename · property · read-only`

```pascal
procedure CkSFtpFile_getFilename(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__filename(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the name of the directory entry. Depending on the entry type, this may be a regular filename, directory name, symbolic-link name, or the name of another special filesystem object.

### SFtpFile.FileType

`Chilkat 11.7.0 · delphidll · SFtpFile · FileType · property · read-only`

```pascal
procedure CkSFtpFile_getFileType(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__fileType(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Identifies the type of directory entry. The returned value is one of the following:

| Value | Meaning |
| :--- | :--- |
| `regular` | A regular file. |
| `directory` | A directory. |
| `symLink` | A symbolic link. |
| `special` | A special file whose more specific type is not reported. |
| `unknown` | The type is unknown or was not provided by the server. |
| `socket` | A socket. |
| `charDevice` | A character device. |
| `blockDevice` | A block device. |
| `fifo` | A FIFO (named pipe). |

The convenience properties `IsRegular`, `IsDirectory`, and `IsSymLink` may be used for the most common entry types.

### SFtpFile.Gid

`Chilkat 11.7.0 · delphidll · SFtpFile · Gid · property · read-only`

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

Returns the numeric group ID associated with the file.

### SFtpFile.Group

`Chilkat 11.7.0 · delphidll · SFtpFile · Group · property · read-only`

```pascal
procedure CkSFtpFile_getGroup(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__group(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the textual group name associated with the file.

**Server requirement:** This attribute is available only when the server supports SFTP version 4 or later and provides owner/group names.

### SFtpFile.IsAppendOnly

`Chilkat 11.7.0 · delphidll · SFtpFile · IsAppendOnly · property · read-only`

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

Returns `True` if the server marks the file as append-only. New data may be added only at the end of the file; existing data cannot be overwritten through normal file writes.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsArchive

`Chilkat 11.7.0 · delphidll · SFtpFile · IsArchive · property · read-only`

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

Returns `True` if the server marks the file for inclusion in backup or archive operations.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsCaseInsensitive

`Chilkat 11.7.0 · delphidll · SFtpFile · IsCaseInsensitive · property · read-only`

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

Applies to directories. Returns `True` when names within the directory should be compared without regard to letter case.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsCompressed

`Chilkat 11.7.0 · delphidll · SFtpFile · IsCompressed · property · read-only`

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

Returns `True` if the file is stored using transparent filesystem-level compression on the server.

This attribute describes how the server stores the file. It does not change the file bytes transferred through SFTP.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsDirectory

`Chilkat 11.7.0 · delphidll · SFtpFile · IsDirectory · property · read-only`

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

Returns `True` if the directory entry is a directory.

### SFtpFile.IsEncrypted

`Chilkat 11.7.0 · delphidll · SFtpFile · IsEncrypted · property · read-only`

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

Returns `True` if the file is stored using transparent filesystem-level encryption on the server.

This attribute describes storage at rest. It does not alter the file bytes returned by read operations or accepted by write operations.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsHidden

`Chilkat 11.7.0 · delphidll · SFtpFile · IsHidden · property · read-only`

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

Returns `True` if the server marks the entry as hidden. Hidden entries are normally omitted from user-facing displays unless the user specifically requests them.

### SFtpFile.IsImmutable

`Chilkat 11.7.0 · delphidll · SFtpFile · IsImmutable · property · read-only`

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

Returns `True` if the server marks the file as immutable. An immutable file cannot normally be deleted, renamed, modified, or used as the target of a new hard link.

Immutability is generally stronger than read-only status, the ordinary permission mask, or an access-control list. On many systems, only a privileged administrator can set or clear this attribute.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsReadOnly

`Chilkat 11.7.0 · delphidll · SFtpFile · IsReadOnly · property · read-only`

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

Returns `True` if the server marks the file as read-only.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsRegular

`Chilkat 11.7.0 · delphidll · SFtpFile · IsRegular · property · read-only`

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

Returns `True` if the directory entry is a regular file rather than a directory, symbolic link, device, socket, FIFO, or other special type.

### SFtpFile.IsSparse

`Chilkat 11.7.0 · delphidll · SFtpFile · IsSparse · property · read-only`

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

Returns `True` if the server identifies the file as sparse. A sparse file can contain unwritten regions, often called holes, that read as zero bytes without consuming equivalent physical disk space.

For example, writing data at an offset of 10 MB may leave the region between the previous end of file and that offset unallocated on disk.

Some servers store all files sparsely and may always set this flag. Other servers cannot reliably determine whether a file is sparse, so a file may be sparse even when this property is `False`.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsSymLink

`Chilkat 11.7.0 · delphidll · SFtpFile · IsSymLink · property · read-only`

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

Returns `True` if the directory entry is a symbolic link.

### SFtpFile.IsSync

`Chilkat 11.7.0 · delphidll · SFtpFile · IsSync · property · read-only`

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

Returns `True` if modifications to the file are committed synchronously to server storage.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.IsSystem

`Chilkat 11.7.0 · delphidll · SFtpFile · IsSystem · property · read-only`

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

Returns `True` if the server marks the file as part of the operating system.

**Server requirement:** This attribute is defined for SFTP version 6 or later.

### SFtpFile.LastAccessTimeStr

`Chilkat 11.7.0 · delphidll · SFtpFile · LastAccessTimeStr · property · read-only`

```pascal
procedure CkSFtpFile_getLastAccessTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__lastAccessTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the file's last-access date and time as an RFC 822-formatted string, such as `Fri, 21 Nov 1997 09:55:06 -0600`.

### SFtpFile.LastModifiedTimeStr

`Chilkat 11.7.0 · delphidll · SFtpFile · LastModifiedTimeStr · property · read-only`

```pascal
procedure CkSFtpFile_getLastModifiedTimeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__lastModifiedTimeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the file's last-modified date and time as an RFC 822-formatted string, such as `Fri, 21 Nov 1997 09:55:06 -0600`.

Use `LastModifiedTime` when a native date/time value is more convenient.

### SFtpFile.Owner

`Chilkat 11.7.0 · delphidll · SFtpFile · Owner · property · read-only`

```pascal
procedure CkSFtpFile_getOwner(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__owner(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the textual owner name associated with the file.

**Server requirement:** This attribute is available only when the server supports SFTP version 4 or later and provides owner/group names.

### SFtpFile.Permissions

`Chilkat 11.7.0 · delphidll · SFtpFile · Permissions · property · read-only`

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

Returns the POSIX-style file-permission bit mask. The values correspond to the permission and special-mode bits in the POSIX `st_mode` field.

| Symbol | Octal value | Meaning |
| :--- | :--- | :--- |
| `S_IRUSR` | `0400` | Owner read |
| `S_IWUSR` | `0200` | Owner write |
| `S_IXUSR` | `0100` | Owner execute |
| `S_IRGRP` | `0040` | Group read |
| `S_IWGRP` | `0020` | Group write |
| `S_IXGRP` | `0010` | Group execute |
| `S_IROTH` | `0004` | Others read |
| `S_IWOTH` | `0002` | Others write |
| `S_IXOTH` | `0001` | Others execute |
| `S_ISUID` | `4000` | Set-user-ID |
| `S_ISGID` | `2000` | Set-group-ID |
| `S_ISVTX` | `1000` | Sticky bit |

Use bitwise AND operations to test individual permission bits.

### SFtpFile.Size32

`Chilkat 11.7.0 · delphidll · SFtpFile · Size32 · property · read-only`

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

Returns the file size in bytes as a 32-bit integer. Returns `-1` when the size cannot be represented by a 32-bit integer. Use `Size64` or `SizeStr` for larger values.

### SFtpFile.Size64

`Chilkat 11.7.0 · delphidll · SFtpFile · Size64 · property · read-only`

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

Returns the file size in bytes as a 64-bit integer.

### SFtpFile.SizeStr

`Chilkat 11.7.0 · delphidll · SFtpFile · SizeStr · property · read-only`

```pascal
procedure CkSFtpFile_getSizeStr(objHandle: HCkSFtpFile; outPropVal: HCkString); stdcall;
function CkSFtpFile__sizeStr(objHandle: HCkSFtpFile): PWideChar; stdcall;
```

Returns the file size in bytes as a base-10 string. This is the string representation of `Size64` and is useful in environments where a 64-bit integer is inconvenient or unavailable.

### SFtpFile.Uid

`Chilkat 11.7.0 · delphidll · SFtpFile · Uid · property · read-only`

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

Returns the numeric user ID associated with the file.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `GetCreateDt` | method | before 11.6.1 | — |
| `GetLastAccessDt` | method | before 11.6.1 | — |
| `GetLastModifiedDt` | method | before 11.6.1 | — |

