SFtpFile ActiveX Reference Documentation

SFtpFile

Current Version: 11.0.0

Represents a remote SFTP file.

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.SFtpFile" instead of "Chilkat.SFtpFile"
For a specific major version, use "Chilkat.SFtpFile.<major_version>", such as "Chilkat.SFtpFile.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.SFtpFile")

(AutoIt)
$obj = ObjCreate("Chilkat.SFtpFile")

(Visual Basic 6.0)
Dim obj As New ChilkatSFtpFile

(VBScript)
set obj = CreateObject("Chilkat.SFtpFile")

(VBA, such as Excel)
Dim obj As New ChilkatSFtpFile
See How to Use ActiveX in Excel

(Delphi)
obj := TChilkatSFtpFile.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.SFtpFile')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.SFtpFile")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.SFtpFile', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.SFtpFile");

Properties

CreateTimeStr
CreateTimeStr As String (read-only)

The file creation date and time. This property is only supported by servers running SFTP v4 or later. The date/time is an RFC822 formatted string.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

top
Filename
Filename As String (read-only)

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

top
FileType
FileType As String (read-only)

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

top
Gid
Gid As Long (read-only)

The integer Group ID of the file.

top
Group
Group As String (read-only)

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

top
IsAppendOnly
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.

top
IsArchive
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.

top
IsCaseInsensitive
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.

top
IsCompressed
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.

top
IsDirectory
IsDirectory As Long (read-only)

If 1, this is a directory.

top
IsEncrypted
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.

top
IsHidden
IsHidden As Long (read-only)

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

top
IsImmutable
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.

top
IsReadOnly
IsReadOnly As Long (read-only)

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

top
IsRegular
IsRegular As Long (read-only)

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

top
IsSparse
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.

top
IsSymLink
IsSymLink As Long (read-only)

1 if this is a symbolic link.

top
IsSync
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.

top
IsSystem
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.

top
LastAccessTimeStr
LastAccessTimeStr As String (read-only)

The last-access date and time as an RFC822 formatted string.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
LastModifiedTimeStr
LastModifiedTimeStr As String (read-only)

The last-modified date and time as an RFC822 formatted string. Other date/time formats can be obtained by calling the GetLastModifiedDt method to return a CkDateTime object, and then use CkDateTime to get the desired format.

top
LastStringResult
LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

top
LastStringResultLen
LastStringResultLen As Long (read-only)

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

top
Owner
Owner As String (read-only)

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

top
Permissions
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

top
Size32
Size32 As Long (read-only)

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

top
SizeStr
SizeStr As String (read-only)

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

top
Uid
Uid As Long (read-only)

The integer User ID of the file.

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "10.1.0"

top

Methods

Deprecated

GetCreateDt
GetCreateDt() As CkDateTime
This method is deprecated.

Applications should instead access the CreateTimeStr property.

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

Returns Nothing on failure

top
GetLastAccessDt
GetLastAccessDt() As CkDateTime
This method is deprecated.

Applications should instead access the LastAccessTimeStr property.

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

Returns Nothing on failure

top
GetLastModifiedDt
GetLastModifiedDt() As CkDateTime
This method is deprecated.

Applications should instead access the LastModifiedTimeStr property.

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

Returns Nothing on failure

top