SFtpDir Delphi ActiveX Reference Documentation
TChilkatSFtpDir
Current Version: 11.5.0
Chilkat.SFtpDir
Holds the files and subdirectories returned from an SFTP directory-read
operation.
Use
Read
Use
Use
Sort entries by filename, timestamps, or size, and load directory
listings returned from completed async tasks.
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
Original path tracking
OriginalPath to see the remote path that was requested
when the directory listing was created.
Entry count
NumFilesAndDirs to determine how many directory
entries are available for iteration.
Filename access
GetFilename to retrieve the name of an entry by
zero-based index.
Full entry details
FileAt to populate an SFtpFile object with
metadata for a selected file or subdirectory.
Sorting and async results
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.
Object Creation
var obj: TChilkatSFtpDir; ... begin obj := TChilkatSFtpDir.Create(Self); ... // When finished, free the object instance. obj.Free();
Properties
DebugLogFilePath
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumFilesAndDirs
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.
OriginalPath
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.
topVerboseLogging
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
FileAt
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.
GetFilename when only the entry name is needed.
Returns 1 for success, 0 for failure.
topGetFilename
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.
FileAt when the application needs the full SFtpFile metadata rather than only the entry name.
Returns a zero-length WideString on failure
topLoadTaskResult
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 1 for success, 0 for failure.
topSort
Reorders the files and subdirectories in this listing according to field.
Set ascending to 1 for ascending order or 0 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. |
Deprecated
GetFileObject
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