DWC_LoginAsync

Syntax

#include <dwc.h>

BOOL DWC_LoginAsync( const u16 * ingamesn,
                     const char* reserved,
                     DWCLoginCallback callback,
                     void* param );

Description

The application checks if the GameSpy server can be used, performs remote authentication, and connects to Nintendo Wi-Fi Connection.

To call this function, the DWC_InitFriendsMatch function must complete through FriendsMatch Library initialization after connecting to the Internet. Continue to call the DWC_ProcessFriendsMatch function after this function is called and the login process will proceed. When the process is complete, the login completion callback will be called.

The authentication server checks to see if the in-game screen name (the name the player is using during the game) is inappropriate in Nintendo Wi-Fi Connection. Get the results of that check with the DWC_GetIngamesnCheckResult function after successfully connecting to Nintendo Wi-Fi connection. Refer to the DWC_CheckProfanity[Ex]Async functions for details on checking for illegal strings.

Be aware that an error communicating with the Authentication server (error code 20109) will be generated if the maker code is undefined in the data registered in ROM.

Also, when not using the FriendsMatch Library, be sure to call the DWC_NASLoginAsync function in place of this one.

Arguments

ingamesn Screen name sent to the authentication server.
  • Use Unicode (little endian UTF16) for the character code.
    Be sure to convert to Unicode when using another type of character code.
  • If original characters not included in Unicode or in the IPL font are used in the screen name, be sure to replace all such characters with spaces.
  • The terminal character should be "\0\0" (0x0000 in u16).
  • If a string of 26 or more characters (excluding the null terminator) has been specified, only the first 25 characters are sent to the authentication server.
reserved Normally, specify NULL. Retained for compatibility with past versions.
callback The pointer to the login completion callback function.
param Parameter for the login completion callback.

Return Values

TRUE The login process starts. The results are indicated via the callback function.
FALSE This is not a good time to call this function, or a NULL has been designated in the ingamesn argument. The callback function will not be called.

See Also

DWC_InitFriendsMatch, DWC_ProcessFriendsMatch, DWC_ShutdownFriendsMatch, DWCLoginCallback, DWC_GetIngamesnCheckResult, DWC_NASLoginAsync, DWC_CheckProfanity[Ex]Async

Revision History

2008/06/25 Added a reference to the DWC_CheckProfanity[Ex]Async functions.
2006/07/24 Corrected errors.
2006/07/03 Inserted an explanation in the function description about the FriendsMatch Library not being in use.
2006/05/30 Added cautionary notes about the maker codes for the ROM registration data.
2006/04/26 Changed the length of the character string that can be designated for ingamesn and added a description.
2006/01/31 Inserted the term "FriendsMatch Library" into the function description.
2005/12/16 Added support for addition of the in-game screen name argument. Corrected errors in Return Values.
2005/07/22 Initial version.


CONFIDENTIAL