SFtpDir ActiveX Reference Documentation

SFtpDir

Current Version: 11.0.0

Requires Chilkat Bundle License

Represents a remote SFTP directory listing.

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.SFtpDir" instead of "Chilkat.SFtpDir"
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.

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.

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.

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 LastErrorText LastErrorText Standard Information

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.

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.

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

LastStringResultLen

LastStringResultLen As Long (read-only)

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

NumFilesAndDirs

NumFilesAndDirs As Long (read-only)

The number of entries in this directory listing.

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.

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.

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.

Methods

FileAt

FileAt(ByVal index As Long, fileObj As ChilkatSFtpFile) As Long

Introduced in version 11.0.0

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

Returns 1 for success, 0 for failure.

GetFilename

GetFilename(ByVal index As Long) As String

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

Returns Nothing on failure

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.

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".)

Deprecated

GetFileObject

GetFileObject(ByVal index As Long) As ChilkatSFtpFile

This method is deprecated.

Applications should instead call FileAt.

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

Returns Nothing on failure