SFtpDir C# Reference Documentation

SFtpDir

Current Version: 11.5.0
Requires Chilkat Bundle License

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.

Object Creation

Chilkat.SFtpDir obj = new Chilkat.SFtpDir();

Properties

DebugLogFilePath
public string DebugLogFilePath {get; set; }

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.

More Information and Examples
(C#) Example showing how to use DebugLogFilePath.(PowerShell) Example showing how to use DebugLogFilePath.
top
LastErrorHtml
public string LastErrorHtml {get; }

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.

top
LastErrorText
public string LastErrorText {get; }

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
public string LastErrorXml {get; }

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.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }

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
public int NumFilesAndDirs {get; }

The number of entries in this directory listing.

top
OriginalPath
public string OriginalPath {get; }

The original path used to fetch this directory listing. This is the string that was originally passed to the OpenDir method when the directory was read.

top
VerboseLogging
public bool VerboseLogging {get; set; }

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
public string Version {get; }

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

More Information and Examples
(C#) How to get the Chilkat version at runtime.(PowerShell) How to get the Chilkat version at runtime.
top

Methods

FileAt
public bool FileAt(int index, SFtpFile fileObj);
Introduced in version 11.0.0

Returns the entry in the directory at the given index. Indexing begins at 0.

Returns true for success, false for failure.

top
GetFilename
public string GetFilename(int index);

Returns the Nth filename in the directory (indexing begins at 0).

Returns null on failure

top
LoadTaskResult
public bool LoadTaskResult(Task task);
Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns true for success, false for failure.

top
Sort
public void Sort(string field, bool ascending);
Introduced in version 9.5.0.79

Sorts the files and sub-directories in ascending or descending order based on the field. Possible values for field are filename, filenameNoCase, lastModifiedTime, lastAccessTime, lastCreateTime, or size. (For case-insensitive filename sorting, use filenameNoCase.)

top

Deprecated

GetFileObject
public SFtpFile GetFileObject(int index);
This method is deprecated and replaced by FileAt

Applications should instead call FileAt.

Returns the Nth entry in the directory. Indexing begins at 0.

Returns null on failure

top