SFtpDir VB.NET Reference Documentation

SFtpDir

Current Version: 11.0.0

Represents a remote SFTP directory listing.

Object Creation

Dim obj As New 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
top
LastErrorHtml
LastErrorHtml As String (ReadOnly)

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 (ReadOnly)

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.

top
LastErrorXml
LastErrorXml As String (ReadOnly)

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 Boolean

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.

top
NumFilesAndDirs
NumFilesAndDirs As Integer (ReadOnly)

The number of entries in this directory listing.

top
OriginalPath
OriginalPath As String (ReadOnly)

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
VerboseLogging As Boolean

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
Version As String (ReadOnly)

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

More Information and Examples
top

Methods

FileAt
Function FileAt(ByVal index As Integer, ByVal fileObj As SFtpFile) As Boolean
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
Function GetFilename(ByVal index As Integer) As String

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

Returns Nothing on failure

top
LoadTaskResult
Function LoadTaskResult(ByVal task As Task) As Boolean
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
Sub Sort(ByVal field As String, ByVal ascending As Boolean)
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
Function GetFileObject(ByVal index As Integer) As SFtpFile
This method is deprecated.

Applications should instead call FileAt.

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

Returns Nothing on failure

top