Transfer Event

Fired during file download/upload.

Syntax

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

virtual INT IPWORKSSSH_CALL FireTransfer(INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszRemoteFile, LPSTR &lpszRemotePath, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

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.

The LocalFile, RemoteFile, and RemotePath parameters provide information about the current transfer.

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

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Edition - Version 20.0 [Build 8501]