peerGetNick
Returns the chat nickname of the local client.
- const gsi_char * peerGetNick(
- PEER peer );
| Routine | Required Header | Distribution |
|---|---|---|
| peerGetNick | <peer.h> | SDKZIP |
Return Value
The chat nickname of the local user. NULL if not connected.
Parameters
- peer
- [in] Initialized peer object.
Remarks
The peerGetNick function returns the chat nickname of the local client. The peer object must be initialized and connected to a chat server. Otherwise a NULL is returned if not connected.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerGetNick | peerGetNickA | peerGetNickW |
peerGetNickW and peerGetNickA are UNICODE and ANSI mapped versions of peerGetNick. The arguments of peerGetNickA are ANSI strings; those of peerGetNickW are wide-character strings.
Section Reference: Gamespy Peer SDK