DirList Event

Fires when a client attempts to open a directory for listing.

Syntax

ANSI (Cross Platform)
virtual int FireDirList(SFTPServerDirListEventParams *e);
typedef struct {
int ConnectionId;
const char *User;
const char *Path;
int BeforeExec;
int StatusCode; int reserved; } SFTPServerDirListEventParams; Unicode (Windows) virtual INT FireDirList(SFTPServerDirListEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR User;
LPCWSTR Path;
BOOL BeforeExec;
INT StatusCode; INT reserved; } SFTPServerDirListEventParams;
- (void)onDirList:(int)connectionId :(NSString*)user :(NSString*)path :(BOOL)beforeExec :(int*)statusCode;
#define EID_SFTPSERVER_DIRLIST 4

virtual INT IPWORKSSFTP_CALL FireDirList(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, BOOL &bBeforeExec, INT &iStatusCode);

Remarks

The DirList event fires when an SFTP client sends an SSH_FXP_OPENDIR request. The Path parameter will contain the path of the directory to list.

When necessary, you should call SetFileList with the list of files and directories in Path.

This event is fired both before and after the directory is listed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are:

  • SSH_FX_OK 0
  • SSH_FX_EOF 1
  • SSH_FX_NO_SUCH_FILE 2
  • SSH_FX_PERMISSION_DENIED 3
  • SSH_FX_FAILURE 4
  • SSH_FX_BAD_MESSAGE 5
  • SSH_FX_NO_CONNECTION 6
  • SSH_FX_CONNECTION_LOST 7
  • SSH_FX_OP_UNSUPPORTED 8
  • SSH_FX_INVALID_HANDLE 9
  • SSH_FX_NO_SUCH_PATH 10
  • SSH_FX_FILE_ALREADY_EXISTS 11
  • SSH_FX_WRITE_PROTECT 12
  • SSH_FX_NO_MEDIA 13
  • SSH_FX_NO_SPACE_ON_FILESYSTEM 14
  • SSH_FX_QUOTA_EXCEEDED 15
  • SSH_FX_UNKNOWN_PRINCIPAL 16
  • SSH_FX_LOCK_CONFLICT 17
  • SSH_FX_DIR_NOT_EMPTY 18
  • SSH_FX_NOT_A_DIRECTORY 19
  • SSH_FX_INVALID_FILENAME 20
  • SSH_FX_LINK_LOOP 21
  • SSH_FX_CANNOT_DELETE 22
  • SSH_FX_INVALID_PARAMETER 23
  • SSH_FX_FILE_IS_A_DIRECTORY 24
  • SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
  • SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
  • SSH_FX_DELETE_PENDING 27
  • SSH_FX_FILE_CORRUPT 28
  • SSH_FX_OWNER_INVALID 29
  • SSH_FX_GROUP_INVALID 30
  • SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8162]