SFtpDir ActiveX 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

Note:
For a specific major version, use "Chilkat.SFtpDir.<major_version>", such as "Chilkat.SFtpDir.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.SFtpDir")

(AutoIt)
$obj = ObjCreate("Chilkat.SFtpDir")

(Visual Basic 6.0)
Dim obj As New ChilkatSFtpDir

(VBScript)
set obj = CreateObject("Chilkat.SFtpDir")

(VBA, such as Excel)
Dim obj As New ChilkatSFtpDir
See How to Use ActiveX in Excel

(Delphi)
obj := TChilkatSFtpDir.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.SFtpDir')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.SFtpDir")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.SFtpDir', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.SFtpDir");

Properties

DebugLogFilePath
DebugLogFilePath As String

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
(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.
top
LastBinaryResult
LastBinaryResult As Variant (read-only)

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.

top
LastErrorHtml
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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
LastErrorXml As String (read-only)

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
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)

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.

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
NumFilesAndDirs
NumFilesAndDirs As Long (read-only)

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
OriginalPath As String (read-only)

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.

top
VerboseLogging
VerboseLogging As Long

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.

top
Version
Version As String (read-only)

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

More Information and Examples
(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.
top

Methods

FileAt
FileAt(ByVal index As Long, fileObj As ChilkatSFtpFile) As Long
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 1 for success, 0 for failure.

top
GetFilename
GetFilename(ByVal index As Long) As String

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 Nothing on failure

top
LoadTaskResult
LoadTaskResult(task As ChilkatTask) As Long
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 1 for success, 0 for failure.

top
Sort
Sort(field As String, ByVal ascending As Long)
Introduced in version 9.5.0.79

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

Deprecated

GetFileObject
GetFileObject(ByVal index As Long) As ChilkatSFtpFile
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 Nothing on failure

top