SFtpDir ActiveX Reference Documentation

SFtpDir

Current Version: 9.5.0.88

Represents a remote SFTP directory listing.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatSFtpDir

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

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

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

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

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

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

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

Properties

LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastMethodSuccess
LastMethodSuccess As Long

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

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

top
NumFilesAndDirs
NumFilesAndDirs As Long (read-only)

The number of entries in this directory listing.

top
OriginalPath
OriginalPath As String (read-only)

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

Methods

GetFilename
GetFilename(ByVal index As Long) As String

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

Returns Nothing on failure

top
GetFileObject
GetFileObject(ByVal index As Long) As ChilkatSFtpFile

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

Returns Nothing on failure

top
LoadTaskResult
LoadTaskResult(task As ChilkatTask) As Long
Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top
Sort
Sort(field As String, ByVal ascending As Long)
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