SFtpDir ActiveX Reference Documentation
SFtpDir
Current Version: 10.1.0
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") (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
LastBinaryResult
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).
topLastMethodSuccess
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.
topLastStringResult
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).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumFilesAndDirs
The number of entries in this directory listing.
topOriginalPath
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.
topMethods
GetFilename
GetFileObject
LoadTaskResult
Loads the SFTP directory object from a completed asynchronous task.
Returns 1 for success, 0 for failure.
topSort
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