SFtpDir Unicode C Reference Documentation

SFtpDir

Current Version: 9.5.0.73

Represents a remote SFTP directory listing.

Create/Dispose

HCkSFtpDirW instance = CkSFtpDirW_Create();
// ...
CkSFtpDirW_Dispose(instance);
HCkSFtpDirW CkSFtpDirW_Create(void);

Creates an instance of the HCkSFtpDirW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkSFtpDirW_Dispose(HCkSFtpDirW handle);

Objects created by calling CkSFtpDirW_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 CkSFtpDirW_Dispose.

Properties

LastMethodSuccess
BOOL CkSFtpDirW_getLastMethodSuccess(HCkSFtpDirW cHandle);
void CkSFtpDirW_putLastMethodSuccess(HCkSFtpDirW 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.

top
NumFilesAndDirs
int CkSFtpDirW_getNumFilesAndDirs(HCkSFtpDirW cHandle);

The number of entries in this directory listing.

top
OriginalPath
void CkSFtpDirW_getOriginalPath(HCkSFtpDirW cHandle, HCkString retval);
const wchar_t *CkSFtpDirW_originalPath(HCkSFtpDirW 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.

top

Methods

GetFilename
BOOL CkSFtpDirW_GetFilename(HCkSFtpDirW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkSFtpDirW_getFilename(HCkSFtpDirW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

top
GetFileObject
HCkSFtpFileW CkSFtpDirW_GetFileObject(HCkSFtpDirW cHandle, int index);

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

Returns NULL on failure

top
LoadTaskResult
BOOL CkSFtpDirW_LoadTaskResult(HCkSFtpDirW cHandle, HCkTaskW 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