chatNickErrorCallback

GameSpy SDK

chatNickErrorCallback

Used in conjuction with the chatConnect functions; called if there was an error with the provided nickname.

typedef void (*chatNickErrorCallback)(
CHAT chat,
int type,
const gsi_char * nick,
int numSuggestedNicks,
const gsi_char ** suggestedNicks,
void * param );
RoutineRequired HeaderDistribution
chatNickErrorCallback<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
type
[in] The type of error: indicates whether the nick was invalid or if it was in use.
nick
[in] The problematic nickname.
numSuggestedNicks
[in] The number of suggested nicknames.
suggestedNicks
[in] A list of suggested alternative nicknames.
param
[in] Pointer to user data. The same param that was passed to chatConnect.

Remarks

Suggested nicks are only provided if type is CHAT_INVALID_UNIQUENICK.
Use chatRetryWithNick to continue the connect attempt with a new nickname; otherwise, call chatDisconnect to stop the connection.