Transfer Event

Fired during file download/upload.


ANSI (Cross Platform)
virtual int FireTransfer(SFTPTransferEventParams *e);
typedef struct {
int Direction;
const char *LocalFile;
const char *RemoteFile;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText;
int Cancel; int reserved; } SFTPTransferEventParams; Unicode (Windows) virtual INT FireTransfer(SFTPTransferEventParams *e);
typedef struct {
INT Direction;
LPCWSTR LocalFile;
LPCWSTR RemoteFile;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText;
BOOL Cancel; INT reserved; } SFTPTransferEventParams;
- (void)onTransfer:(int)direction :(NSString*)localFile :(NSString*)remoteFile :(long long)bytesTransferred :(int)percentDone :(NSData*)text :(int*)cancel;

virtual INT IPWORKSSFTP_CALL FireTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bCancel);


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 C++ Edition - Version 20.0 [Build 8263]