peerGetPlayerInfoNoWait
Retrieve a players IP and profile ID. Uses a cached copy.
- PEERBool peerGetPlayerInfoNoWait(
- PEER peer,
- const gsi_char * nick,
- unsigned int * IP,
- int * profileID );
Routine | Required Header | Distribution |
---|---|---|
peerGetPlayerInfoNoWait | <peer.h> | SDKZIP |
Return Value
Returns PEERTrue if a cached copy was available. PEERFalse otherwise.
Parameters
- peer
- [in] Initialized peer object.
- nick
- [in] Chat nickname of the target player.
- IP
- [out] IP address of the target player.
- profileID
- [out] Profile ID of the target player.
Remarks
The peerGetPlayerInfoNoWait function returns the cached copy of the players IP and profile ID. Use in conjuction with peerAlwaysGetPlayerInfo. Returns PEERFalse if the info is not available. Reasons why the info would not be immediately available include the local player not being in any common room with the player, the player is not using the Peer SDK, or we have just joined a room and we don’t yet have everyone’s info.
Even if this succeeds, the profile ID can be 0 if its not available. This function will fail if not connected.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
peerGetPlayerInfoNoWait | peerGetPlayerInfoNoWaitA | peerGetPlayerInfoNoWaitW |
peerGetPlayerInfoNoWaitW and peerGetPlayerInfoNoWaitA are UNICODE and ANSI mapped versions of peerGetPlayerInfoNoWait. The arguments of peerGetPlayerInfoNoWaitA are ANSI strings; those of peerGetPlayerInfoNoWaitW are wide-character strings.
Section Reference: Gamespy Peer SDK