Back to product page

FileTransferStart event


Fires when file transfer starts.

Syntax

  • Basic
Private Sub object_FileTransferStart (ByRef Contact, ByRef File, ByRef Action)
The FileTransferStart(Contact,File,Action) syntax has these parts:
ContactXMPPContact object
FileXMPPFile object
ActionXMPPActionsEnum enumeration

Remarks

This event will be triggered when file is about to be transferred. It can be result of your SendFile call, or when remote side initiates file transfer. At this point you can change any File object's properties to tweak transfer the way you need it - such as specifying full path in Name property, change DataIP etc.

After this event fires, FileTransferProgress event will be fired several times as file is transferred. At the end of file transfer FileTransferEnd event will be fired.

When Contact argument is NULL (Nothing in VB) it means that wodXMPP does not know who is downloading the file. This is typically result of ServeFile method and someone downloading such file.

Platforms

Windows