CkSFtpDir Java Programming
Reference Documentation

CkSFtpDir

Represents a remote SFTP directory listing.

Object Creation

CkSFtpDir obj = new CkSFtpDir();

Properties

// str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

// str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

// str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

// Returns an integer value
get_NumFilesAndDirs( )

The number of entries in this directory listing.

// str is a CkString object (output)
get_OriginalPath( str )

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.

// Returns a boolean value
get_Utf8( )

// b is a boolean (input)
put_Utf8( b )

To be documented soon...

Methods

// index is an integer (input)
// Returns a CkSFtpFile object
GetFileObject( index )

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

// index is an integer (input)
// outStr is a CkString object (output)
// Returns a boolean value
GetFilename( index, outStr )

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

Returns true for success, false for failure.

// filename is a string (input)
// Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

// index is an integer (input)
// Returns a string
getFilename( index )

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

Returns a null on failure

// Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

Returns a null on failure

// Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

Returns a null on failure

// Returns a string
lastErrorXml( )

Error information in XML format for the last method called.

Returns a null on failure

// Returns a string
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.

Returns a null on failure