SFtpDir C Reference Documentation
SFtpDir
Current Version: 10.1.0
Represents a remote SFTP directory listing.
Create/Dispose
HCkSFtpDir instance = CkSFtpDir_Create(); // ... CkSFtpDir_Dispose(instance);
Creates an instance of the HCkSFtpDir object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkSFtpDir_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkSFtpDir_Dispose.
Properties
LastMethodSuccess
void CkSFtpDir_putLastMethodSuccess(HCkSFtpDir cHandle, BOOL newVal);
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.
topNumFilesAndDirs
The number of entries in this directory listing.
topOriginalPath
const char *CkSFtpDir_originalPath(HCkSFtpDir cHandle);
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.
topUtf8
void CkSFtpDir_putUtf8(HCkSFtpDir cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topMethods
GetFilename
const char *CkSFtpDir_getFilename(HCkSFtpDir cHandle, int index);
Returns the Nth filename in the directory (indexing begins at 0).
Returns TRUE for success, FALSE for failure.
topGetFileObject
LoadTaskResult
Loads the SFTP directory object from a completed asynchronous task.
Returns TRUE for success, FALSE 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