ChilkatSFtpFile ActiveX Reference

ChilkatSFtpFile

Represents a remote SFTP file.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatSFtpFile
(ASP)
set obj = Server.CreateObject("Chilkat.SFtpFile")
(VBScript)
set obj = CreateObject("Chilkat.SFtpFile")
(Delphi)
obj := TChilkatSFtpFile.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.SFtpFile')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.SFtpFile', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.SFtpFile");

Properties

CreateTime As Date (read-only)

The file creation date and time. This property is only supported by servers running SFTP v4 or later.

FileType As String (read-only)

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

Filename As String (read-only)

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

Gid As Long (read-only)

To be documented soon...

Group As String (read-only)

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

IsAppendOnly As Long (read-only)

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

IsArchive As Long (read-only)

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

IsCaseInsensitive As Long (read-only)

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.

IsCompressed As Long (read-only)

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.

IsDirectory As Long (read-only)

If 1, this is a directory.

IsEncrypted As Long (read-only)

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.

IsHidden As Long (read-only)

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

IsImmutable As Long (read-only)

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.

IsReadOnly As Long (read-only)

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

IsRegular As Long (read-only)

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

IsSparse As Long (read-only)

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.

IsSymLink As Long (read-only)

1 if this is a symbolic link.

IsSync As Long (read-only)

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.

IsSystem As Long (read-only)

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

LastAccessTime As Date (read-only)

The last-access date and time.

LastErrorHtml As String (read-only)

To be documented soon.Error information in HTML format for the last method called.

LastErrorText As String (read-only)

Error information in plain-text format for the last method called.

LastErrorXml As String (read-only)

Error information in XML format for the last method called.

LastModifiedTime As Date (read-only)

The last-modified date and time.

Owner As String (read-only)

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

Permissions As Long (read-only)

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

Size32 As Long (read-only)

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

SizeStr As String (read-only)

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

Uid As Long (read-only)

To be documented soon...

Methods

SaveLastError(logFilename As String) As Long

Saves the last error information to an XML formatted file.

Serialize() As String

To be documented soon...

Unserialize(inStr As String) As Long

To be documented soon...