ReadFile Event
This event is fired when a file read request is received.
Syntax
sftpserver.on('ReadFile', [callback])
Callback
The 'callback' is called when the 'ReadFile' event is emited.
function(e){ }
The argument 'e' has the following properties:
e.connectionID e.handle e.offset e.size e.operationStatus
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 |