xfAbortTransfer

#include <fte.h>

DWORD WINAPI xfAbortTransfer(hConnection, dwFlags)
HCONNECTION hConnection; /* handle of connection to terminate */
DWORD
dwFlags; /* flag specifying reason for termination */

The xfAbortTransfer function tells the system to terminate a file transfer.

Parameters

hConnection

Identifies the connection to terminate.

dwFlags

Specifies the conditions for termination. It can be one of the following:

Value

Meaning

XF_SYSTEM_ABORT

System specified termination due to error such as not enough disk space or fatal application error.

XF_USER_ABORT

User specified termination, for instance by choosing a cancel button.


Return Value

The return value specifies the result of the termination request. It can be any one of the values list in section 2.2.4. File Transfer Errors.

Comments

The xfAbortTransfer function is generally called after an error condition occurs and when abnormally terminating the transfer. Use the xfAbortTransfer function call after the application detects the error and needs to terminate the tranfer. The file transfer engine will stop receiving files on that connection and notifies the remote computer.

See Also

xfDisconnect