peerChangeNick
Change the chat nickname associated with the local client. This does not affect the account name.
- void peerChangeNick(
- PEER peer,
- const gsi_char * newNick,
- peerChangeNickCallback callback,
- void * param,
- PEERBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| peerChangeNick | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- newNick
- [in] The nickname to assign to the local user.
- callback
- [in] Callback function will be called when the operation completes.
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
- blocking
- [in] When set to PEERTrue this function will not return until the operation has completed.
Remarks
The peerChangeNick function may be used to change a user’s nickname as it appears in chat. This has no affect on GameSpy profile names such as those used for presence detection and buddy lists. Only one instance of a nickname may be in use at a time. The attempt may fail if the nick is invalid or in use. This will fail if Peer is not connected.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerChangeNick | peerChangeNickA | peerChangeNickW |
peerChangeNickW and peerChangeNickA are UNICODE and ANSI mapped versions of peerChangeNick. The arguments of peerChangeNickA are ANSI strings; those of peerChangeNickW are wide-character strings.
Section Reference: Gamespy Peer SDK