ReadFile Event

This event is fired when a file read request is received.

Syntax

class SFTPServerReadFileEventParams {
public:
  qint64 ConnectionID();
  const QString &Handle();
  int Offset();
  int Size();
  int OperationStatus();
  void SetOperationStatus(int iOperationStatus);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadFile(SFTPServerReadFileEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireReadFile(SFTPServerReadFileEventParams *e) {...}

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: