SFtpDir Tcl Reference Documentation
SFtpDir
Current Version: 11.0.0
Represents a remote SFTP directory listing.
Object Creation
set mySFtpDir [new CkSFtpDir]
Properties
DebugLogFilePath
# ckStr is a CkString
CkSFtpDir_get_DebugLogFilePath $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_debugLogFilePath $mySFtpDir]
CkSFtpDir_put_DebugLogFilePath $mySFtpDir $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.
LastErrorHtml
# ckStr is a CkString
CkSFtpDir_get_LastErrorHtml $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_lastErrorHtml $mySFtpDir]
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
CkSFtpDir_get_LastErrorText $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_lastErrorText $mySFtpDir]
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
CkSFtpDir_get_LastErrorXml $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_lastErrorXml $mySFtpDir]
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 [CkSFtpDir_get_LastMethodSuccess $mySFtpDir]
CkSFtpDir_put_LastMethodSuccess $mySFtpDir $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.
NumFilesAndDirs
set intVal [CkSFtpDir_get_NumFilesAndDirs $mySFtpDir]
The number of entries in this directory listing.
topOriginalPath
# ckStr is a CkString
CkSFtpDir_get_OriginalPath $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_originalPath $mySFtpDir]
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.
topVerboseLogging
set boolVal [CkSFtpDir_get_VerboseLogging $mySFtpDir]
CkSFtpDir_put_VerboseLogging $mySFtpDir $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
CkSFtpDir_get_Version $mySFtpDir $ckStr
set strVal [CkSFtpDir_get_version $mySFtpDir]
Methods
FileAt
Returns the entry in the directory at the given index. Indexing begins at 0.
Returns 1 for success, 0 for failure.
topGetFilename
# outStr is a CkString (output)
set status [CkSFtpDir_GetFilename $index $outStr]
set retStr [CkSFtpDir_getFilename $mySFtpDir $index]
Returns the Nth filename in the directory (indexing begins at 0).
Returns 1 for success, 0 for failure.
topLoadTaskResult
Loads the SFTP directory object from a completed asynchronous task.
Returns 1 for success, 0 for failure.
topSort
# ascending is a boolean
CkSFtpDir_Sort $field $ascending
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".)
topDeprecated
GetFileObject
Applications should instead call FileAt.
Returns the Nth entry in the directory. Indexing begins at 0.
Returns NULL on failure