TChilkatSFtpFile Delphi ActiveX Reference Documentation

TChilkatSFtpFile

Current Version: 9.5.0.75

Represents a remote SFTP file.

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.

Two things are required to use an ActiveX in Delphi:

  1. 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.
  2. See also: ActiveX Registration Tutorial
  3. 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_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

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

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_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_v9_5_0_TLB;

Object Creation

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

Properties

CreateTimeStr
property CreateTimeStr: WideString readonly

The same as the CreateTime property, but returns the date/time as an RFC822 formatted string.

top
Filename
property Filename: WideString readonly

The filename (or directory name, symbolic link name, etc.)

top
FileType
property FileType: WideString readonly

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

top
Gid
property Gid: Integer readonly

The integer Group ID of the file.

top
Group
property Group: WideString readonly

The group ownership of the file. This property is only supported by servers running SFTP v4 or later.

top
IsAppendOnly
property IsAppendOnly: Integer readonly

If 1, this file may only be appended. This property is only supported by servers running SFTP v6 or later.

top
IsArchive
property IsArchive: Integer readonly

If 1, the file should be included in backup / archive operations. This property is only supported by servers running SFTP v6 or later.

top
IsCaseInsensitive
property IsCaseInsensitive: Integer readonly

This attribute applies only to directories. This attribute means that files and directory names in this directory should be compared without regard to case. This property is only supported by servers running SFTP v6 or later.

top
IsCompressed
property IsCompressed: Integer readonly

The file is stored on disk using file-system level transparent compression. This flag does not affect the file data on the wire. This property is only supported by servers running SFTP v6 or later.

top
IsDirectory
property IsDirectory: Integer readonly

If 1, this is a directory.

top
IsEncrypted
property IsEncrypted: Integer readonly

The file is stored on disk using file-system level transparent encryption. This flag does not affect the file data on the wire (for either READ or WRITE requests.) This property is only supported by servers running SFTP v6 or later.

top
IsHidden
property IsHidden: Integer readonly

If 1, the file SHOULD NOT be shown to user unless specifically requested.

top
IsImmutable
property IsImmutable: Integer readonly

The file cannot be deleted or renamed, no hard link can be created to this file, and no data can be written to the file.

This bit implies a stronger level of protection than ReadOnly, the file permission mask or ACLs. Typically even the superuser cannot write to immutable files, and only the superuser can set or remove the bit.

This property is only supported by servers running SFTP v6 or later.

top
IsReadOnly
property IsReadOnly: Integer readonly

If 1, the file is read-only. This property is only supported by servers running SFTP v6 or later.

top
IsRegular
property IsRegular: Integer readonly

1 if this is a normal file (not a directory or any of the other non-file types).

top
IsSparse
property IsSparse: Integer readonly

The file is a sparse file; this means that file blocks that have not been explicitly written are not stored on disk. For example, if a client writes a buffer at 10 M from the beginning of the file, the blocks between the previous EOF marker and the 10 M offset would not consume physical disk space.

Some servers may store all files as sparse files, in which case this bit will be unconditionally set. Other servers may not have a mechanism for determining if the file is sparse, and so the file MAY be stored sparse even if this flag is not set.

This property is only supported by servers running SFTP v6 or later.

top
IsSymLink
property IsSymLink: Integer readonly

1 if this is a symbolic link.

top
IsSync
property IsSync: Integer readonly

When the file is modified, the changes are written synchronously to the disk. This property is only supported by servers running SFTP v6 or later.

top
IsSystem
property IsSystem: Integer readonly

1 if the file is part of the operating system. This property is only supported by servers running SFTP v6 or later.

top
LastAccessTimeStr
property LastAccessTimeStr: WideString readonly

The same as the LastAccessTime property, but returns the date/time as an RFC822 formatted string.

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
LastModifiedTimeStr
property LastModifiedTimeStr: WideString readonly

The same as the LastModifiedTime property, but returns the date/time as an RFC822 formatted string.

top
Owner
property Owner: WideString readonly

The owner of the file. This property is only supported by servers running SFTP v4 or later.

top
Permissions
property Permissions: Integer readonly

The 'permissions' field contains a bit mask specifying file permissions. These permissions correspond to the st_mode field of the stat structure defined by POSIX [IEEE.1003-1.1996].

This protocol uses the following values for the symbols declared in the POSIX standard.

       S_IRUSR  0000400 (octal)
       S_IWUSR  0000200
       S_IXUSR  0000100
       S_IRGRP  0000040
       S_IWGRP  0000020
       S_IXGRP  0000010
       S_IROTH  0000004
       S_IWOTH  0000002
       S_IXOTH  0000001
       S_ISUID  0004000
       S_ISGID  0002000
       S_ISVTX  0001000

top
Size32
property Size32: Integer readonly

Size of the file in bytes. If the size is too large for 32-bits, a -1 is returned.

top
SizeStr
property SizeStr: WideString readonly

Same as Size64, but the number is returned as a string in decimal format.

top
Uid
property Uid: Integer readonly

The integer User ID of the file.

top

Methods

GetCreateDt
function GetCreateDt(): TCkDateTime;

Returns the file creation date and time (GMT / UTC). This method is only supported by servers running SFTP v4 or later.

Returns nil on failure

top
GetLastAccessDt
function GetLastAccessDt(): TCkDateTime;

Returns the last-access date and time (GMT / UTC).

Returns nil on failure

top
GetLastModifiedDt
function GetLastModifiedDt(): TCkDateTime;

Returns the last-modified date and time (GMT / UTC).

Returns nil on failure

top