Transfer Event

Fired during file transfer.

Syntax

ANSI (Cross Platform)
virtual int FireTransfer(XMPPTransferEventParams *e);
typedef struct {
int Direction;
const char *FileId;
const char *Filename;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText;
int Cancel; int reserved; } XMPPTransferEventParams; Unicode (Windows) virtual INT FireTransfer(XMPPTransferEventParams *e);
typedef struct {
INT Direction;
LPCWSTR FileId;
LPCWSTR Filename;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText;
BOOL Cancel; INT reserved; } XMPPTransferEventParams;
- (void)onTransfer:(int)direction :(NSString*)fileId :(NSString*)filename :(long long)bytesTransferred :(int)percentDone :(NSData*)text :(int*)cancel;
#define EID_XMPP_TRANSFER 17

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LPSTR &lpszFileId, LPSTR &lpszFilename, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bCancel);

Remarks

This event will fire when sending or receiving. 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 PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

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

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

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

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