gpFreeTransfer

GameSpy SDK

gpFreeTransfer

This function is used to free a file transfer.

GPResult gpFreeTransfer(
GPConnection * connection,
GPTransfer transfer );
RoutineRequired HeaderDistribution
gpFreeTransfer<gp.h>SDKZIP

Return Value

This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.

Parameters

connection
[in] A GP connection interface.
transfer
[in] A pointer to a GPTransfer object.

Remarks

This function is used to free a transfer object. If the transfer has completed, then this will simple free the object’s resources. If the transfer has not yet completed, this will also cancel the transfer, causing the remote profile to get a GP_TRANSFER_CANCELLED callback.