FileClose Event

Fires when a client attempts to close an open file or directory handle.

Syntax

ANSI (Cross Platform)
virtual int FireFileClose(SFTPServerFileCloseEventParams *e);
typedef struct {
int ConnectionId;
const char *User;
const char *Path;
const char *Handle;
int StatusCode; int reserved; } SFTPServerFileCloseEventParams; Unicode (Windows) virtual INT FireFileClose(SFTPServerFileCloseEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR User;
LPCWSTR Path;
LPCWSTR Handle;
INT StatusCode; INT reserved; } SFTPServerFileCloseEventParams;
- (void)onFileClose:(int)connectionId :(NSString*)user :(NSString*)path :(NSString*)handle :(int*)statusCode;
#define EID_SFTPSERVER_FILECLOSE 8

virtual INT IPWORKSSFTP_CALL FireFileClose(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, LPSTR &lpszHandle, INT &iStatusCode);

Remarks

The FileClose event fires when an SFTP client sends an SSH_FXP_CLOSE request. The Path parameter will contain the path of the file to close.

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]