SFtpDir Perl Reference Documentation

CkSFtpDir

Current Version: 11.5.0

Requires Chilkat Bundle License

Chilkat.SFtpDir

Inspect, sort, and iterate an SFTP directory listing.

Chilkat.SFtpDir represents a directory listing returned by an SFTP operation. It provides the original path used to fetch the listing, the number of files and subdirectories found, methods for retrieving filenames or full SFtpFile entry details by index, sorting support, and a way to load a completed asynchronous directory-listing result.

Directory listing object

Holds the files and subdirectories returned from an SFTP directory-read operation.

Original path tracking

Use OriginalPath to see the remote path that was requested when the directory listing was created.

Entry count

Read NumFilesAndDirs to determine how many directory entries are available for iteration.

Filename access

Use GetFilename to retrieve the name of an entry by zero-based index.

Full entry details

Use FileAt to populate an SFtpFile object with metadata for a selected file or subdirectory.

Sorting and async results

Sort entries by filename, timestamps, or size, and load directory listings returned from completed async tasks.

Common pattern: Use a Chilkat.SFtp object to open or read a remote directory, then use the returned SFtpDir object to inspect NumFilesAndDirs, optionally call Sort, and loop from index 0 through the final entry. Use GetFilename when only names are needed, or FileAt when the application needs the full SFtpFile metadata for each entry.

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.

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.

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 LastErrorText LastErrorText Standard Information

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.

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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

NumFilesAndDirs

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

The number of entries in this directory listing.

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.

Utf8

# $boolVal is a boolean
$boolVal = $sFtpDir->get_Utf8();
$sFtpDir->put_Utf8($boolVal);

When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.

More Information and Examples

Strings in Perl: Encoding, UTF-8, and Source File Format Considerations

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.

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.

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.

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.

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.

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

Deprecated

GetFileObject

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

This method is deprecated and replaced by FileAt

Applications should instead call FileAt.

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

Returns null on failure