ListDirectory Method

List the current directory specified by RemotePath on an SFTP server.

Syntax

ANSI (Cross Platform)
int ListDirectory();

Unicode (Windows)
INT ListDirectory();
- (void)listDirectory;
#define MID_SFTP_LISTDIRECTORY 13

IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The file listing is received through the DirList event.

If there is no SSH session in place, one is automatically created by the component first.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8263]