peerGetPlayerPing

GameSpy SDK

peerGetPlayerPing

Returns the cached ping between the local player and the specified remote player.

PEERBool peerGetPlayerPing(
PEER peer,
const gsi_char * nick,
int * ping );
RoutineRequired HeaderDistribution
peerGetPlayerPing<peer.h>SDKZIP

Return Value

This function return PEERTrue if a cached ping time was available.  PEERFalse otherwise.

Parameters

peer
[in] Initialized peer object.
nick
[in] Nick of the target player.
ping
[out] This will be set to the cached ping time.

Remarks

The peerGetPlayerPing function is used to retrieve the cached ping value for the specified remote player. Returns PEERFalse if we don't have or can't get a ping for this player. This function only works if a title is set.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerGetPlayerPingpeerGetPlayerPingApeerGetPlayerPingW

peerGetPlayerPingW and peerGetPlayerPingA are UNICODE and ANSI mapped versions of peerGetPlayerPing. The arguments of peerGetPlayerPingA are ANSI strings; those of peerGetPlayerPingW are wide-character strings.

Section Reference: Gamespy Peer SDK