SFtpDir PureBasic Reference Documentation
SFtpDir
Current Version: 9.5.0.98
Represents a remote SFTP directory listing.
Object Creation
obj.i = CkSFtpDir::ckCreate()
; Make sure to dispose of the object when finished like this:
CkSFtpDir::ckDispose(obj);
Properties
LastMethodSuccess
Declare setCkLastMethodSuccess(obj.i, value.i)
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.
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
Returns the Nth filename in the directory (indexing begins at 0).
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
topGetFileObject
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