Transfer Event

Fired during file download/upload.

Syntax

class SFTPTransferEventParams {
public:
  int Direction();
  const QString &LocalFile();
  const QString &RemoteFile();
  qint64 BytesTransferred();
  int PercentDone();
  const QByteArray &Text();
  bool Cancel();
  void SetCancel(bool bCancel);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Transfer(SFTPTransferEventParams *e);
// Or, subclass SFTP and override this emitter function. virtual int FireTransfer(SFTPTransferEventParams *e) {...}

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.

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