SFtpDir Chilkat2 Perl Reference Documentation

Chilkat2::SFtpDir

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

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

use Chilkat2;

my $sFtpDir = Chilkat2::SFtpDir->new;
# or set properties (and RaiseError) at creation:
# my $sFtpDir = Chilkat2::SFtpDir->new(VerboseLogging => 1, RaiseError => 1);

my $sFtpDir = Chilkat2::SFtpDir->new(Property => $value, ...);

Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/SFtpDir.pm file holds only this class's documentation (perldoc Chilkat2::SFtpDir).

Perl frees the object when its last reference goes (undef $sFtpDir, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::SFtpDir';): an object is a blessed hash reference whose hash is free for the subclass's own fields.

my $boolVal = $sFtpDir->RaiseError;
$sFtpDir->RaiseError($boolVal);

When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.

Errors

A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::SFtpDir'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.

Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.

Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.

Properties

DebugLogFilePath

# $strVal is a string
my $strVal = $sFtpDir->DebugLogFilePath;
$sFtpDir->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 (read-only)
my $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 (read-only)
my $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

top

LastErrorXml

# $strVal is a string (read-only)
my $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
my $boolVal = $sFtpDir->LastMethodSuccess;
$sFtpDir->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.

top

NumFilesAndDirs

# $intVal is an integer (read-only)
my $intVal = $sFtpDir->NumFilesAndDirs;

Returns the number of entries in this directory listing.

The count includes every item returned by the server, such as regular files, directories, symbolic links, and special entries. Valid zero-based indexes range from 0 through NumFilesAndDirs - 1.

top

OriginalPath

# $strVal is a string (read-only)
my $strVal = $sFtpDir->OriginalPath;

Returns the original remote path used to create this directory listing.

This is the same path string that was supplied to the SFTP directory-open operation. It identifies the requested directory and is retained with the listing for later reference.

top

VerboseLogging

# $boolVal is a boolean
my $boolVal = $sFtpDir->VerboseLogging;
$sFtpDir->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 (read-only)
my $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 Chilkat2::SFtpFile
# $success is true or false
my $success = $sFtpDir->FileAt($index, $fileObj);

Introduced in version 11.0.0

Copies the metadata for the directory entry at the zero-based index into fileObj.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

The populated SFtpFile object provides the entry name, type, size, timestamps, ownership, permissions, and any additional attributes supplied by the SFTP server.

Use GetFilename when only the entry name is needed.

Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.

top

GetFilename

# $index is an integer
# $str is a string or undef
my $str = $sFtpDir->GetFilename($index);

Returns the filename of the directory entry at the zero-based index.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

Use FileAt when the application needs the full SFtpFile metadata rather than only the entry name.

Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.

top

Sort

# $field is a string
# $ascending is a boolean
$sFtpDir->Sort($field, $ascending);

Introduced in version 9.5.0.79

Reorders the files and subdirectories in this listing according to field.

Set ascending to 1 for ascending order or 0 for descending order. The new order is used by index-based methods such as GetFilename and FileAt.

field	Sort key
`filename`	Filename using the normal case-sensitive comparison.
`filenameNoCase`	Filename using a case-insensitive comparison.
`lastModifiedTime`	Last-modified date and time.
`lastAccessTime`	Last-access date and time.
`lastCreateTime`	Creation date and time.
`size`	Entry size in bytes.

Returns the object, so calls can be chained.

top