SFtpDir Delphi DLL Reference Documentation
SFtpDir
Current Version: 11.0.0
Represents a remote SFTP directory listing.
Create/Dispose
var myObject: HCkSFtpDir; begin myObject := CkSFtpDir_Create(); // ... CkSFtpDir_Dispose(myObject); end;
Creates an instance of the HCkSFtpDir object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkSFtpDir_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
DebugLogFilePath
procedure CkSFtpDir_putDebugLogFilePath(objHandle: HCkSFtpDir; newPropVal: PWideChar); stdcall;
function CkSFtpDir__debugLogFilePath(objHandle: HCkSFtpDir): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorHtml
function CkSFtpDir__lastErrorHtml(objHandle: HCkSFtpDir): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkSFtpDir__lastErrorText(objHandle: HCkSFtpDir): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkSFtpDir__lastErrorXml(objHandle: HCkSFtpDir): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkSFtpDir_putLastMethodSuccess(objHandle: HCkSFtpDir; newPropVal: wordbool); stdcall;
Indicates the success or failure of the most recent method call: True means success, False 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.
NumFilesAndDirs
The number of entries in this directory listing.
topOriginalPath
function CkSFtpDir__originalPath(objHandle: HCkSFtpDir): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topVerboseLogging
procedure CkSFtpDir_putVerboseLogging(objHandle: HCkSFtpDir; newPropVal: wordbool); stdcall;
If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
function CkSFtpDir__version(objHandle: HCkSFtpDir): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
FileAt
index: Integer;
fileObj: HCkSFtpFile): wordbool; stdcall;
Returns the entry in the directory at the given index. Indexing begins at 0.
Returns True for success, False for failure.
topGetFilename
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkSFtpDir__getFilename(objHandle: HCkSFtpDir;
index: Integer): PWideChar; stdcall;
Returns the Nth filename in the directory (indexing begins at 0).
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topLoadTaskResult
Loads the SFTP directory object from a completed asynchronous task.
Returns True for success, False for failure.
topSort
field: PWideChar;
ascending: wordbool) stdcall;
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".)
topDeprecated
GetFileObject
Applications should instead call FileAt.
Returns the Nth entry in the directory. Indexing begins at 0.
Returns nil on failure