SFtpDir C Reference Documentation
SFtpDir
Current Version: 11.0.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
DebugLogFilePath
void CkSFtpDir_putDebugLogFilePath(HCkSFtpDir cHandle, const char *newVal);
const char *CkSFtpDir_debugLogFilePath(HCkSFtpDir cHandle);
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.
LastErrorHtml
const char *CkSFtpDir_lastErrorHtml(HCkSFtpDir cHandle);
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.
topLastErrorText
const char *CkSFtpDir_lastErrorText(HCkSFtpDir cHandle);
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.
LastErrorXml
const char *CkSFtpDir_lastErrorXml(HCkSFtpDir cHandle);
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.
topLastMethodSuccess
void CkSFtpDir_putLastMethodSuccess(HCkSFtpDir cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE 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.
NumFilesAndDirs
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 and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.
VerboseLogging
void CkSFtpDir_putVerboseLogging(HCkSFtpDir cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
const char *CkSFtpDir_version(HCkSFtpDir cHandle);
Methods
FileAt
Returns the entry in the directory at the given index. Indexing begins at 0.
Returns TRUE for success, FALSE for failure.
topGetFilename
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.
topLoadTaskResult
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".)
topDeprecated
GetFileObject
Applications should instead call FileAt.
Returns the Nth entry in the directory. Indexing begins at 0.
Returns NULL on failure