TChilkatSFtpDir Delphi ActiveX Reference Documentation

TChilkatSFtpDir

Current Version: 10.1.0

Represents a remote SFTP directory listing.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).

Two things are required to use an ActiveX in Delphi:

The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
See also: ActiveX Registration Tutorial
The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
Check the "Generate Component Wrappers" checkbox.
Select a directory where the unit files (.pas and .dcr) should be generated.
Select "Create Unit" and then "Finish".
Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatSFtpDir;
...
begin
obj := TChilkatSFtpDir.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

LastBinaryResult

property LastBinaryResult: OleVariant readonly

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top

LastMethodSuccess

property LastMethodSuccess: Integer

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.

top

LastStringResult

property LastStringResult: WideString readonly

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

top

LastStringResultLen

property LastStringResultLen: Integer readonly

The length, in characters, of the string contained in the LastStringResult property.

top

NumFilesAndDirs

property NumFilesAndDirs: Integer readonly

The number of entries in this directory listing.

top

OriginalPath

property OriginalPath: WideString readonly

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 GetFilename(index: Integer): WideString;

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

Returns a zero-length WideString on failure

top

GetFileObject

function GetFileObject(index: Integer): TChilkatSFtpFile;

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

Returns nil on failure

top

LoadTaskResult

function LoadTaskResult(task: TChilkatTask): Integer;

Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top

Sort

procedure Sort(field: WideString; ascending: Integer);

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