TElSftpClient.OnDirectoryListing event

TElSftpClient.OnDirectoryListing

This event is fired when a portion of directory listing is received.

Declaration

[C#]
event TSBSftpDirectoryListingEvent OnDirectoryListing;
delegate void TSBSftpDirectoryListingEvent(Object Sender, TElSftpFileInfo[] Listing);

[VB.NET]
Event OnDirectoryListing As TSBSftpDirectoryListingEvent
Delegate Sub TSBSftpDirectoryListingEvent(ByVal Sender As Object, ByVal Listing As TElSftpFileInfo[])

[Pascal]
property OnDirectoryListing : TSBSftpDirectoryListingEvent;
TSBSftpDirectoryListingEvent = procedure (Sender: TObject; Listing : array of TElSftpFileInfo) of object;

[C++]
    void get_OnDirectoryListing(TSBSftpDirectoryListingEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnDirectoryListing(TSBSftpDirectoryListingEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSftpDirectoryListingEvent)(void * _ObjectData, TObjectHandle Sender, const TElSftpFileInfoHandle pListing[], int32_t szListing);

[PHP]
    TSBSftpDirectoryListingEvent|callable|NULL get_OnDirectoryListing()
    void set_OnDirectoryListing(TSBSftpDirectoryListingEvent|callable|NULL $Value)
    callable TSBSftpDirectoryListingEvent(TObject $Sender, array of TElSftpFileInfo $Listing)

[Java]
    TSBSftpDirectoryListingEvent getOnDirectoryListing();
    void setOnDirectoryListing(TSBSftpDirectoryListingEvent Value);
    TSBSftpDirectoryListingEvent.Callback OnDirectoryListing = new TSBSftpDirectoryListingEvent.Callback() {
        public void TSBSftpDirectoryListingEventCallback(TObject Sender, TElSftpFileInfo[] Listing) {
            //...
        }
    }

Parameters

Listing - array of TElSftpFileInfo objects
pListing -
szListing - the length of pcListing.

Description

This event is fired by TElSftpClient when server notifies that the next portion of directory listing is arrived. This event follows the call to ReadDirectory routine unless the complete listing is received.
If there are no more entries to return, OnError event is fired with error code SSH_ERROR_EOF.