SFtpDir Tcl Reference Documentation

SFtpDir

Current Version: 9.5.0.73

Represents a remote SFTP directory listing.

Object Creation

set mySFtpDir [new CkSFtpDir]

Properties

LastMethodSuccess
boolean 1/0
set boolVal [CkSFtpDir_get_LastMethodSuccess $mySFtpDir]
CkSFtpDir_put_LastMethodSuccess $mySFtpDir $boolVal

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
NumFilesAndDirs
integer
set intVal [CkSFtpDir_get_NumFilesAndDirs $mySFtpDir]

The number of entries in this directory listing.

top
OriginalPath
string
# 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.

top
Utf8
boolean 1/0
set boolVal [CkSFtpDir_get_Utf8 $mySFtpDir]
CkSFtpDir_put_Utf8 $mySFtpDir $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top

Methods

GetFilename
# index is an integer
# 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.

top
GetFileObject
# returns a CkSFtpFile
# index is an integer
set ret_sFtpFile [CkSFtpDir_GetFileObject $index]

Returns the Nth entry in the directory. Indexing begins at 0.

Returns NULL on failure

top
LoadTaskResult
# task is a CkTask
set status [CkSFtpDir_LoadTaskResult $task]
Introduced in version 9.5.0.52

Loads the SFTP directory object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top