SFtpDir Perl Reference Documentation

CkSFtpDir

Current Version: 11.0.0
Requires Chilkat Bundle License

Represents a remote SFTP directory listing.

Object Creation

$obj = chilkat::CkSFtpDir->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_DebugLogFilePath($ckStr);
$strVal = $sFtpDir->debugLogFilePath();
$sFtpDir->put_DebugLogFilePath($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.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_LastErrorHtml($ckStr);
$strVal = $sFtpDir->lastErrorHtml();

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
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_LastErrorText($ckStr);
$strVal = $sFtpDir->lastErrorText();

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_LastErrorXml($ckStr);
$strVal = $sFtpDir->lastErrorXml();

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
# $boolVal is a boolean
$boolVal = $sFtpDir->get_LastMethodSuccess();
$sFtpDir->put_LastMethodSuccess($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.

top
NumFilesAndDirs
# $intVal is an integer
$intVal = $sFtpDir->get_NumFilesAndDirs();

The number of entries in this directory listing.

top
OriginalPath
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_OriginalPath($ckStr);
$strVal = $sFtpDir->originalPath();

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
VerboseLogging
# $boolVal is a boolean
$boolVal = $sFtpDir->get_VerboseLogging();
$sFtpDir->put_VerboseLogging($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.

top
Version
# $strVal is a string
# $ckStr is a CkString
$sFtpDir->get_Version($ckStr);
$strVal = $sFtpDir->version();

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

FileAt
# $index is an integer
# $fileObj is a CkSFtpFile
$status = $sFtpDir->FileAt($index, $fileObj);
Introduced in version 11.0.0

Returns the entry in the directory at the given index. Indexing begins at 0.

Returns 1 for success, 0 for failure.

top
GetFilename
# $index is an integer
# $outStr is a CkString (output)
$status = $sFtpDir->GetFilename($index, $outStr);
$retStr = $sFtpDir->getFilename($index);

Returns the Nth filename in the directory (indexing begins at 0).

Returns 1 for success, 0 for failure.

top
LoadTaskResult
# $task is a CkTask
$status = $sFtpDir->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
Sort
# $field is a string
# $ascending is a boolean
$sFtpDir->Sort($field, $ascending);
Introduced in version 9.5.0.79

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".)

top

Deprecated

GetFileObject
# returns a CkSFtpFile
# $index is an integer
$ret_sFtpFile = $sFtpDir->GetFileObject($index);
This method is deprecated.

Applications should instead call FileAt.

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

Returns null on failure

top