Player::GetReceiveFilePosition

Defined in: C4Messages.h

Returns the current position in the file being received from a player.

Prototype

uint64 GetReceiveFilePosition(void) const;

Description

If a file is currently being received from a player, then the current write position of this file can be retrieved by calling the GetReceiveFilePosition function. This function can be used in conjunction with the Player::GetReceiveFileSize function to determine what percentage of a file has been downloaded. If no file is currently being received, then the value returned by GetReceiveFilePosition is zero.

The Player::ReceivingFile function returns a boolean value indicating whether a file is currently being received.