Back to FlowSsh Documentation

TransferHandler Typedef

[C]

typedef bool (__cdecl* FlowSshC_TransferHandler)(
  void* handlerData,
  bool done,
  FlowSshC_TransferStat const* transferStat,
  FlowSshC_TransferErr const* error);

Parameters

  • handlerData: Data passed to the initiating call.
  • done: This handler can be called multiple times. On success, the last call will have done=true, error!=NULL.
  • transferStat: Pointer to a TransferStat structure.
  • error: Pointer to a TransferErr structure. This pointer is NULL on success.

Return Value

Return false to cancel the transfer.

Remarks

Reports the progress of a file download/upload. The handler may be called multiple times. On success, the last call will have done=true, error!=NULL. If you return false or if an error occurs, the transfer is canceled.