gpGetFileSize

GameSpy SDK

gpGetFileSize

This function is used to get the size of a file being transferred.

GPResult gpGetFileSize(
GPConnection * connection,
GPTransfer transfer,
int index,
int * size );
RoutineRequired HeaderDistribution
gpGetFileSize<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.
index
[in] The index of the file within the GPTransfer object.
size
[in] The size of the file.

Remarks

This function is used to get the size of a file being transferred. The size of each file is checked when the transfer is initialized, and this is the size that will be reported before the file is actually transferred. The size of the file is checked again when the file actually begins transferring, and this is the size that will be reported from that moment on (the two sizes will only be different if the file has changed during that time).

Section Reference: Gamespy Presence SDK