SFtpFile Tcl Reference Documentation
SFtpFile
Current Version: 11.0.0
Represents a remote SFTP file.
Object Creation
set mySFtpFile [new CkSFtpFile]
Properties
CreateTimeStr
# ckStr is a CkString
CkSFtpFile_get_CreateTimeStr $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_createTimeStr $mySFtpFile]
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.
topDebugLogFilePath
# ckStr is a CkString
CkSFtpFile_get_DebugLogFilePath $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_debugLogFilePath $mySFtpFile]
CkSFtpFile_put_DebugLogFilePath $mySFtpFile $strVal
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.
Filename
# ckStr is a CkString
CkSFtpFile_get_Filename $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_filename $mySFtpFile]
The filename (or directory name, symbolic link name, etc.)
topFileType
# ckStr is a CkString
CkSFtpFile_get_FileType $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_fileType $mySFtpFile]
One of the following values:
regular directory symLink special unknown socket charDevice blockDevice fifotop
Gid
set intVal [CkSFtpFile_get_Gid $mySFtpFile]
The integer Group ID of the file.
topGroup
# ckStr is a CkString
CkSFtpFile_get_Group $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_group $mySFtpFile]
The group ownership of the file. This property is only supported by servers running SFTP v4 or later.
topIsAppendOnly
set boolVal [CkSFtpFile_get_IsAppendOnly $mySFtpFile]
If 1
, this file may only be appended. This property is only supported by servers running SFTP v6 or later.
IsArchive
set boolVal [CkSFtpFile_get_IsArchive $mySFtpFile]
If 1
, the file should be included in backup / archive operations. This property is only supported by servers running SFTP v6 or later.
IsCaseInsensitive
set boolVal [CkSFtpFile_get_IsCaseInsensitive $mySFtpFile]
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.
topIsCompressed
set boolVal [CkSFtpFile_get_IsCompressed $mySFtpFile]
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.
topIsDirectory
set boolVal [CkSFtpFile_get_IsDirectory $mySFtpFile]
If 1
, this is a directory.
IsEncrypted
set boolVal [CkSFtpFile_get_IsEncrypted $mySFtpFile]
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.
topIsHidden
set boolVal [CkSFtpFile_get_IsHidden $mySFtpFile]
If 1
, the file SHOULD NOT be shown to user unless specifically requested.
IsImmutable
set boolVal [CkSFtpFile_get_IsImmutable $mySFtpFile]
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.
topIsReadOnly
set boolVal [CkSFtpFile_get_IsReadOnly $mySFtpFile]
If 1
, the file is read-only. This property is only supported by servers running SFTP v6 or later.
IsRegular
set boolVal [CkSFtpFile_get_IsRegular $mySFtpFile]
1
if this is a normal file (not a directory or any of the other non-file types).
IsSparse
set boolVal [CkSFtpFile_get_IsSparse $mySFtpFile]
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.
topIsSymLink
set boolVal [CkSFtpFile_get_IsSymLink $mySFtpFile]
1
if this is a symbolic link.
IsSync
set boolVal [CkSFtpFile_get_IsSync $mySFtpFile]
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.
topIsSystem
set boolVal [CkSFtpFile_get_IsSystem $mySFtpFile]
1
if the file is part of the operating system. This property is only supported by servers running SFTP v6 or later.
LastAccessTimeStr
# ckStr is a CkString
CkSFtpFile_get_LastAccessTimeStr $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_lastAccessTimeStr $mySFtpFile]
The last-access date and time as an RFC822 formatted string.
topLastErrorHtml
# ckStr is a CkString
CkSFtpFile_get_LastErrorHtml $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_lastErrorHtml $mySFtpFile]
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.
topLastErrorText
# ckStr is a CkString
CkSFtpFile_get_LastErrorText $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_lastErrorText $mySFtpFile]
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.
LastErrorXml
# ckStr is a CkString
CkSFtpFile_get_LastErrorXml $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_lastErrorXml $mySFtpFile]
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.
topLastMethodSuccess
set boolVal [CkSFtpFile_get_LastMethodSuccess $mySFtpFile]
CkSFtpFile_put_LastMethodSuccess $mySFtpFile $boolVal
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.
LastModifiedTimeStr
# ckStr is a CkString
CkSFtpFile_get_LastModifiedTimeStr $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_lastModifiedTimeStr $mySFtpFile]
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.
topOwner
# ckStr is a CkString
CkSFtpFile_get_Owner $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_owner $mySFtpFile]
The owner of the file. This property is only supported by servers running SFTP v4 or later.
topPermissions
set intVal [CkSFtpFile_get_Permissions $mySFtpFile]
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 0001000top
Size32
set intVal [CkSFtpFile_get_Size32 $mySFtpFile]
Size of the file in bytes. If the size is too large for 32-bits, a -1 is returned.
topSize64
set int64Val [CkSFtpFile_get_Size64 $mySFtpFile]
Size of the file in bytes. If the file size is a number too large for 64 bits, you have an AMAZINGLY large disk drive.
topSizeStr
# ckStr is a CkString
CkSFtpFile_get_SizeStr $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_sizeStr $mySFtpFile]
Same as Size64, but the number is returned as a string in decimal format.
topUid
set intVal [CkSFtpFile_get_Uid $mySFtpFile]
The integer User ID of the file.
topVerboseLogging
set boolVal [CkSFtpFile_get_VerboseLogging $mySFtpFile]
CkSFtpFile_put_VerboseLogging $mySFtpFile $boolVal
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.
Version
# ckStr is a CkString
CkSFtpFile_get_Version $mySFtpFile $ckStr
set strVal [CkSFtpFile_get_version $mySFtpFile]
Methods
Deprecated
GetCreateDt
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 NULL
on failure
GetLastAccessDt
Applications should instead access the LastAccessTimeStr
property.
Returns the last-access date and time (GMT / UTC).
Returns NULL
on failure
GetLastModifiedDt
Applications should instead access the LastModifiedTimeStr
property.
Returns the last-modified date and time (GMT / UTC).
Returns NULL
on failure