ReadFile Event
This event is fired when a file read request is received.
Syntax
ANSI (Cross Platform) virtual int FireReadFile(SFTPServerReadFileEventParams *e);
typedef struct {
int64 ConnectionID;
const char *Handle;
int Offset;
int Size;
int OperationStatus; int reserved; } SFTPServerReadFileEventParams; Unicode (Windows) virtual INT FireReadFile(SFTPServerReadFileEventParams *e);
typedef struct {
LONG64 ConnectionID;
LPCWSTR Handle;
INT Offset;
INT Size;
INT OperationStatus; INT reserved; } SFTPServerReadFileEventParams;
- (void)onReadFile:(long long)connectionID :(NSString*)handle :(int)offset :(int)size :(int*)operationStatus;
#define EID_SFTPSERVER_READFILE 31 virtual INT SECUREBLACKBOX_CALL FireReadFile(LONG64 &lConnectionID, LPSTR &lpszHandle, INT &iOffset, INT &iSize, INT &iOperationStatus);
Remarks
This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset andSize denote the location and size of the file piece.
Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.
Set OperationStatus to one of the below values according to the outcome of the request processing:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |