chatChangeNick
Change the chat nickname associated with the local client. This does not affect the account name.
- void chatChangeNick(
- CHAT chat,
- const gsi_char * newNick,
- chatChangeNickCallback callback,
- void * param,
- CHATBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| chatChangeNick | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- newNick
- [in] Nickname to assign to the local user.
- callback
- [in] Optional user-supplied function to be called when the operation has completed.
- param
- [in] Optional pointer to user data; will be passed unmodified to the callback function.
- blocking
- [in] If CHATTrue, return only after the operation has completed; otherwise, return immediately.
Remarks
The chatChangeNick 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.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatChangeNick | chatChangeNickA | chatChangeNickW |
chatChangeNickW and chatChangeNickA are UNICODE and ANSI mapped versions of chatChangeNick. The arguments of chatChangeNickA are ANSI strings; those of chatChangeNickW are wide-character strings.
Section Reference: Gamespy Chat SDK