Chilkat_9_5_0.SFtpDir PHP ActiveX Reference Documentation

Chilkat_9_5_0.SFtpDir

Current Version: 9.5.0.89

Represents a remote SFTP directory listing.

Object Creation

$obj = new COM("Chilkat_9_5_0.SFtpDir");

Properties

LastBinaryResult
VARIANT LastBinaryResult (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 true. 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
bool LastMethodSuccess

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
  • 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
string LastStringResult (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 true. 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
int LastStringResultLen (read-only)
Introduced in version 9.5.0.53

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

top
NumFilesAndDirs
int NumFilesAndDirs (read-only)

The number of entries in this directory listing.

top
OriginalPath
string OriginalPath (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
string GetFilename(int index)

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

Returns null on failure

top
GetFileObject
Chilkat_9_5_0.SFtpFile GetFileObject(int index)

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

Returns null on failure

top
LoadTaskResult
bool LoadTaskResult(Chilkat_9_5_0.Task task)
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
void Sort(string field, bool ascending)
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