SFtpDir Delphi DLL Reference Documentation

SFtpDir

Current Version: 9.5.0.97

Represents a remote SFTP directory listing.

Create/Dispose

var
myObject: HCkSFtpDir;

begin
myObject := CkSFtpDir_Create();

// ...

CkSFtpDir_Dispose(myObject);
end;
function CkSFtpDir_Create: HCkSFtpDir; stdcall;

Creates an instance of the HCkSFtpDir object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkSFtpDir_Dispose(handle: HCkSFtpDir); stdcall;

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.

Properties

LastMethodSuccess
function CkSFtpDir_getLastMethodSuccess(objHandle: HCkSFtpDir): wordbool; stdcall;
procedure CkSFtpDir_putLastMethodSuccess(objHandle: HCkSFtpDir; newPropVal: wordbool); stdcall;

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
function CkSFtpDir_getNumFilesAndDirs(objHandle: HCkSFtpDir): Integer; stdcall;

The number of entries in this directory listing.

top
OriginalPath
procedure CkSFtpDir_getOriginalPath(objHandle: HCkSFtpDir; outPropVal: HCkString); stdcall;
function CkSFtpDir__originalPath(objHandle: HCkSFtpDir): PWideChar; stdcall;

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
function CkSFtpDir_GetFilename(objHandle: HCkSFtpDir;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkSFtpDir__getFilename(objHandle: HCkSFtpDir;
    index: Integer): PWideChar; stdcall;

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

Returns True for success, False for failure.

top
GetFileObject
function CkSFtpDir_GetFileObject(objHandle: HCkSFtpDir;
    index: Integer): HCkSFtpFile; stdcall;

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

Returns nil on failure

top
LoadTaskResult
function CkSFtpDir_LoadTaskResult(objHandle: HCkSFtpDir;
    task: HCkTask): wordbool; stdcall;
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
procedure CkSFtpDir_Sort(objHandle: HCkSFtpDir;
    field: PWideChar;
    ascending: wordbool) stdcall;
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