SFtpDir Delphi DLL Reference Documentation

SFtpDir

Current Version: 11.5.0

Chilkat.SFtpDir

Inspect, sort, and iterate an SFTP directory listing.

Chilkat.SFtpDir represents a directory listing returned by an SFTP operation. It provides the original path used to fetch the listing, the number of files and subdirectories found, methods for retrieving filenames or full SFtpFile entry details by index, sorting support, and a way to load a completed asynchronous directory-listing result.

Directory listing object

Holds the files and subdirectories returned from an SFTP directory-read operation.

Original path tracking

Use OriginalPath to see the remote path that was requested when the directory listing was created.

Entry count

Read NumFilesAndDirs to determine how many directory entries are available for iteration.

Filename access

Use GetFilename to retrieve the name of an entry by zero-based index.

Full entry details

Use FileAt to populate an SFtpFile object with metadata for a selected file or subdirectory.

Sorting and async results

Sort entries by filename, timestamps, or size, and load directory listings returned from completed async tasks.

Common pattern: Use a Chilkat.SFtp object to open or read a remote directory, then use the returned SFtpDir object to inspect NumFilesAndDirs, optionally call Sort, and loop from index 0 through the final entry. Use GetFilename when only names are needed, or FileAt when the application needs the full SFtpFile metadata for each entry.

Create/Dispose

var
myObject: HCkSFtpDir;

begin
myObject := CkSFtpDir_Create();

// ...

CkSFtpDir_Dispose(myObject);
end;

function CkSFtpDir_Create: HCkSFtpDir; stdcall;

Creates an instance of the HCkSFtpDir 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 CkSFtpDir_Dispose(handle: HCkSFtpDir); stdcall;

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

Properties

DebugLogFilePath

procedure CkSFtpDir_getDebugLogFilePath(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
procedure CkSFtpDir_putDebugLogFilePath(objHandle: HCkSFtpDir; newPropVal: PWideChar); stdcall;
function CkSFtpDir__debugLogFilePath(objHandle: HCkSFtpDir): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

top

LastErrorHtml

procedure CkSFtpDir_getLastErrorHtml(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__lastErrorHtml(objHandle: HCkSFtpDir): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top

LastErrorText

procedure CkSFtpDir_getLastErrorText(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__lastErrorText(objHandle: HCkSFtpDir): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

top

LastErrorXml

procedure CkSFtpDir_getLastErrorXml(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__lastErrorXml(objHandle: HCkSFtpDir): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top

LastMethodSuccess

function CkSFtpDir_getLastMethodSuccess(objHandle: HCkSFtpDir): wordbool; stdcall;
procedure CkSFtpDir_putLastMethodSuccess(objHandle: HCkSFtpDir; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top

NumFilesAndDirs

function CkSFtpDir_getNumFilesAndDirs(objHandle: HCkSFtpDir): Integer; stdcall;

Returns the number of entries in this directory listing.

The count includes every item returned by the server, such as regular files, directories, symbolic links, and special entries. Valid zero-based indexes range from 0 through NumFilesAndDirs - 1.

top

OriginalPath

procedure CkSFtpDir_getOriginalPath(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__originalPath(objHandle: HCkSFtpDir): PWideChar; stdcall;

Returns the original remote path used to create this directory listing.

This is the same path string that was supplied to the SFTP directory-open operation. It identifies the requested directory and is retained with the listing for later reference.

See the notes about PWideChar memory ownership and validity.

top

VerboseLogging

function CkSFtpDir_getVerboseLogging(objHandle: HCkSFtpDir): wordbool; stdcall;
procedure CkSFtpDir_putVerboseLogging(objHandle: HCkSFtpDir; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top

Version

procedure CkSFtpDir_getVersion(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__version(objHandle: HCkSFtpDir): PWideChar; stdcall;

Version of the component/library, such as "10.1.0"

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

top

Methods

FileAt

function CkSFtpDir_FileAt(objHandle: HCkSFtpDir;
index: Integer;
fileObj: HCkSFtpFile): wordbool; stdcall;

Introduced in version 11.0.0

Copies the metadata for the directory entry at the zero-based index into fileObj.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

The populated SFtpFile object provides the entry name, type, size, timestamps, ownership, permissions, and any additional attributes supplied by the SFTP server.

Use GetFilename when only the entry name is needed.

Returns True for success, False for failure.

top

GetFilename

function CkSFtpDir_GetFilename(objHandle: HCkSFtpDir;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkSFtpDir__getFilename(objHandle: HCkSFtpDir;
    index: Integer): PWideChar; stdcall;

Returns the filename of the directory entry at the zero-based index.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

Use FileAt when the application needs the full SFtpFile metadata rather than only the entry name.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

top

LoadTaskResult

function CkSFtpDir_LoadTaskResult(objHandle: HCkSFtpDir;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.52

Loads this SFtpDir object from the result of a completed asynchronous Task.

The task must represent an asynchronous SFTP operation whose result is a directory listing. Call this method after the task has finished to transfer the listing data into the current object.

Returns True for success, False for failure.

top

Sort

procedure CkSFtpDir_Sort(objHandle: HCkSFtpDir;
field: PWideChar;
ascending: wordbool) stdcall;

Introduced in version 9.5.0.79

Reorders the files and subdirectories in this listing according to field.

Set ascending to True for ascending order or False for descending order. The new order is used by index-based methods such as GetFilename and FileAt.

field	Sort key
`filename`	Filename using the normal case-sensitive comparison.
`filenameNoCase`	Filename using a case-insensitive comparison.
`lastModifiedTime`	Last-modified date and time.
`lastAccessTime`	Last-access date and time.
`lastCreateTime`	Creation date and time.
`size`	Entry size in bytes.

top

Deprecated

GetFileObject

function CkSFtpDir_GetFileObject(objHandle: HCkSFtpDir;
index: Integer): HCkSFtpFile; stdcall;

This method is deprecated and replaced by FileAt

Deprecated: Use FileAt instead.

Returns an SFtpFile object containing the metadata for the directory entry at the zero-based index.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

Returns nil on failure

top