RVL DWC Library Constants

Constants

Definitions


#include <dwc.h>
				
#define   DWC_COMMONSTR_MAX_KEY_VALUE_LEN         4096
#define   DWC_MAX_HOSTS                           (16)
#define   DWC_TIMEOUT_COUNT                       (10000)
#define   DWC_MAX_PLAYER_NAME                     26
#define   DWC_INVALID_AID                         (0xff)
#define   DWC_MAX_CONNECTIONS                     32
#define   DWC_QR2_GAME_KEY_START                  100
#define   DWC_QR2_RESERVED_KEYS                   (100-50)
#define   DWC_QR2_GAME_RESERVED_KEYS              (DWC_MAX_REGISTERED_KEYS-DWC_QR2_RESERVED_KEYS-DWC_QR2_RESERVED_KEYS)
#define   DWC_CONNECTION_USERDATA_LEN             4
#define   DWC_ND_FILENAME_LEN                     32
#define   DWC_ND_FILEATTR_LEN                     10
#define   DWC_ND_FILEEXPLSIN_LEN                  50
#define   DWC_ND_THREAD_PRIORITY                  17
#define   DWC_ND_LENGTH_GAMECODE                  4
#define   DWC_ND_LENGTH_PASSWORD                  16
#define   DWC_RNK_DATA_MAX                        764
#define   DWC_RNK_CATEGORY_MAX                    1000
#define   DWC_RNK_GET_MAX                         30
#define   DWC_RNK_FRIENDS_MAX                     64
#define   DWC_SVL_HOST_LENGTH                     64
#define   DWC_SVL_TOKEN_LENGTH                    300
#define   DWC_SVL_STATUSDATA_LENGTH               1
#define   DWC_TRANSPORT_SEND_MAX                  1465

Description

DWC_COMMONSTR_MAX_KEY_VALUE_LEN Maximum string length shared by the general-purpose strings key and value.
DWC_MAX_HOSTS Maximum number of connections.
DWC_TIMEOUT_COUNT Time until timeout.
DWC_MAX_PLAYER_NAME Maximum length of player names (in-game screen names) (25 double-byte characters + "\0\0").
DWC_INVALID_AID Value indicating an invalid AID.
DWC_MAX_CONNECTIONS Maximum number of simultaneous connections.
DWC_QR2_GAME_KEY_START Start value of game-defined keys.
DWC_QR2_RESERVED_KEYS Number of keys reserved by DWC.
DWC_QR2_GAME_RESERVED_KEYS Maximum number of keys that can be used by the game (default is 154).
DWC_CONNECTION_USERDATA_LEN Length of buffer used for matchmaking connection conditions.
DWC_ND_FILENAME_LEN Maximum string length for the file name specified when getting a file.
DWC_ND_FILEATTR_LEN Maximum string length for the attribute specified before getting a file.
DWC_ND_FILEEXPLSIN_LEN Maximum string length of UTF16BE format descriptive text being specified for the file.
DWC_ND_THREAD_PRIORITY Thread priority used in the download library.
DWC_ND_LENGTH_GAMECODE Byte length of DL game code (gamecd).
DWC_ND_LENGTH_PASSWORD Byte length of the secret key (passwd).
DWC_RNK_DATA_MAX Maximum size of user-defined data.
DWC_RNK_CATEGORY_MAX Maximum value that can be specified for a category.
DWC_RNK_GET_MAX Upper limit on the maximum number of rankings that can be retrieved.
DWC_RNK_FRIENDS_MAX Maximum number of friends.
DWC_SVL_HOST_LENGTH Maximum number of characters in the host name.
DWC_SVL_TOKEN_LENGTH Maximum number of characters in the token.
DWC_SVL_STATUSDATA_LENGTH Status size.
DWC_TRANSPORT_SEND_MAX Maximum size that can be sent at one time.

Enumerated Types

Error Codes for Console Friend Library

enum DWCCfError {
    DWC_CF_ERROR_NONE
    DWC_CF_ERROR_NOFRIENDDATA
    DWC_CF_ERROR_CRC
    DWC_CF_ERROR_PARAM
    DWC_CF_ERROR_DATA_BROKEN
    DWC_CF_ERROR_MSGOBJ_ALREADY_SET
    DWC_CF_ERROR_MSGOBJ_PROTECTED
    DWC_CF_ERROR_MSGOBJ_FULL
    DWC_CF_ERROR_NWC24_INTERNAL
    DWC_CF_ERROR_USERDATA
    DWC_CF_ERROR_MEMORY
    DWC_CF_ERROR_GETINFO
    DWC_CF_ERROR_MAX
};
DWC_CF_ERROR_NONE Succeeded.
DWC_CF_ERROR_NOFRIENDDATA No friend data is attached to the specified message.
DWC_CF_ERROR_CRC The friend code CRC is abnormal.
DWC_CF_ERROR_PARAM Illegal parameter.
DWC_CF_ERROR_DATA_BROKEN The game friend information is corrupted.
DWC_CF_ERROR_MSGOBJ_ALREADY_SET Friend registration information is already appended to NWC24MsgObj.
DWC_CF_ERROR_MSGOBJ_PROTECTED NWC24MsgObj cannot be changed.
DWC_CF_ERROR_MSGOBJ_FULL The limit for appending binary data to NWC24MsgObj has been reached.
DWC_CF_ERROR_NWC24_INTERNAL An NWC24 function internal error.
DWC_CF_ERROR_USERDATA Creation of the friend code from user data has failed.
DWC_CF_ERROR_MEMORY Insufficient memory.
DWC_CF_ERROR_GETINFO Failed to obtain friend's console information.
DWC_CF_ERROR_MAX

Types of Messages Sent

enum DWCCfMsgType {
    DWC_CF_MSG_TYPE_REQUEST
    DWC_CF_MSG_TYPE_RESPONSE_ACCEPT
    DWC_CF_MSG_TYPE_RESPONSE_DENY
    DWC_CF_MSG_TYPE_REQUEST_REMIND
};
DWC_CF_MSG_TYPE_REQUEST Friend registration request.
DWC_CF_MSG_TYPE_RESPONSE_ACCEPT Response granting a friend registration request.
DWC_CF_MSG_TYPE_RESPONSE_DENY Response denying a friend registration request.
DWC_CF_MSG_TYPE_REQUEST_REMIND A request to prompt the user about a friend registration request.
In the current version, this is the same as DWC_CF_MSG_TYPE_REQUEST.

Enumeration Type that Indicates Connection Test Results

enum DWCTestInetResult {
    DWC_TESTINET_SUCCEEDED
    DWC_TESTINET_FAILED
    DWC_TESTINET_FAILED_TIMEOUT
    DWC_TESTINET_FAILED_DNS
    DWC_TESTINET_FAILED_CONNECT
    DWC_TESTINET_FAILED_INVALIDRESPONSE
    DWC_TESTINET_FAILED_PROXY_DNS
    DWC_TESTINET_FAILED_PROXY_CONNECT
    DWC_TESTINET_FAILED_UNKNOWN
};
DWC_TESTINET_SUCCEEDED Connection to the Internet has been confirmed.
DWC_TESTINET_FAILED Connection test could not be performed.
DWC_TESTINET_FAILED_TIMEOUT Connection test failed (timeout error).
DWC_TESTINET_FAILED_DNS Connection test failed (DNS retrieval error).
DWC_TESTINET_FAILED_CONNECT Connection test failed (error in communicating with the connection test server).
DWC_TESTINET_FAILED_INVALIDRESPONSE Connection test failed (invalid response).
DWC_TESTINET_FAILED_PROXY_DNS Connection test failed (DNS retrieval error at the proxy server).
DWC_TESTINET_FAILED_PROXY_CONNECT Connection test failed (error in communicating with the connection test server via the proxy server).
DWC_TESTINET_FAILED_UNKNOWN Connection test failed (unknown error).

Persistent Server Login States

enum  {
    DWC_PERS_STATE_INIT          0
    DWC_PERS_STATE_LOGIN
    DWC_PERS_STATE_CONNECTED
    DWC_PERS_STATE_NUM
};
DWC_PERS_STATE_INIT Initial state.
DWC_PERS_STATE_LOGIN Logged on.
DWC_PERS_STATE_CONNECTED Connected.
DWC_PERS_STATE_NUM

Error Enumerators

enum DWCError {
    DWC_ERROR_NONE                    0
    DWC_ERROR_DS_MEMORY_ANY
    DWC_ERROR_AUTH_ANY
    DWC_ERROR_AUTH_OUT_OF_SERVICE
    DWC_ERROR_AUTH_STOP_SERVICE
    DWC_ERROR_AC_ANY
    DWC_ERROR_NETWORK
    DWC_ERROR_GHTTP_ANY
    DWC_ERROR_DISCONNECTED
    DWC_ERROR_FATAL
    DWC_ERROR_FRIENDS_SHORTAGE
    DWC_ERROR_NOT_FRIEND_SERVER
    DWC_ERROR_SERVER_FULL
    DWC_ERROR_ND_ANY
    DWC_ERROR_ND_HTTP
    DWC_ERROR_SVL_ANY
    DWC_ERROR_SVL_HTTP
    DWC_ERROR_PROF_PARSEERR
    DWC_ERROR_PROF_HTTP
    DWC_ERROR_DB_ANY
    DWC_ERROR_SC_CONNECT_BLOCK
    DWC_ERROR_NETWORK_LIGHT
    DWC_ERROR_NUM
};
DWC_ERROR_NONE No error.
DWC_ERROR_DS_MEMORY_ANY Error related to system save data.
DWC_ERROR_AUTH_ANY Authentication-related error.
DWC_ERROR_AUTH_OUT_OF_SERVICE Service terminated.
DWC_ERROR_AUTH_STOP_SERVICE Service stopped temporarily.
DWC_ERROR_AC_ANY Error related to automatic connection.
DWC_ERROR_NETWORK Other network error.
DWC_ERROR_GHTTP_ANY GHTTP(HTTP)-related error.
DWC_ERROR_DISCONNECTED Disconnected.
DWC_ERROR_FATAL Fatal error.
DWC_ERROR_FRIENDS_SHORTAGE Attempted to begin friend-specified peer matchmaking without the specified number of valid friends.
DWC_ERROR_NOT_FRIEND_SERVER With server-client matchmaking, either the server-specified friends are not mutual friends, or the server is down.
DWC_ERROR_SERVER_FULL The server-client matchmaking server has exceeded the maximum number of participants.
DWC_ERROR_ND_ANY Download library error.
DWC_ERROR_ND_HTTP Download library HTTP error.
DWC_ERROR_SVL_ANY Service locator error.
DWC_ERROR_SVL_HTTP Service locator HTTP error.
DWC_ERROR_PROF_PARSEERR Illegal character string check error.
DWC_ERROR_PROF_HTTP Illegal character string check HTTP error.
DWC_ERROR_DB_ANY DB library error.
DWC_ERROR_SC_CONNECT_BLOCK Client connection was denied by the server during server-client matchmaking.
DWC_ERROR_NETWORK_LIGHT NETWORK-related error handled as a light error.
DWC_ERROR_NUM

Error Types Indicating the Procedure Required on Error Detection

enum DWCErrorType {
    DWC_ETYPE_NO_ERROR           0
    DWC_ETYPE_LIGHT
    DWC_ETYPE_SHOW_ERROR
    DWC_ETYPE_SHUTDOWN_FM
    DWC_ETYPE_SHUTDOWN_GHTTP
    DWC_ETYPE_SHUTDOWN_ND
    DWC_ETYPE_DISCONNECT
    DWC_ETYPE_FATAL
    DWC_ETYPE_NUM
};
DWC_ETYPE_NO_ERROR No error.
DWC_ETYPE_LIGHT Only a game-specific display; error code display is not necessary.Recovery is possible by calling the DWC_ClearError function.
DWC_ETYPE_SHOW_ERROR Display the error code.Recovery is possible by calling the DWC_ClearError function.
DWC_ETYPE_SHUTDOWN_FM The FriendsMatch library must be shut down by calling the DWC_ShutdownFriendsMatch function. Display the error code.
DWC_ETYPE_SHUTDOWN_GHTTP Call the following library release functions, as needed.The DWC_RnkShutdown function (General-Purpose Ranking Library). Display the error code.
DWC_ETYPE_SHUTDOWN_ND You must call the DWC_NdCleanupAsync function and close the download library. Display the error code.
DWC_ETYPE_DISCONNECT Call the following library release functions as needed: DWC_ShutdownFriendsMatch function (FriendsMatch library)DWC_NdCleanupAsync function (Download library)DWC_RnkShutdown function (General-Purpose Ranking library). *See Note below. After this, communications must be terminated by calling SOCleanup(). Display the error code.
Note: Because the General-Purpose Ranking library uses the HTTP Communications library, DWC_InitGHTTP and DWC_ShutdownGHTTP are called from inside the initialize and exit operations of the General-Purpose Ranking library.
Note: In the current version, the application cannot use DWC_GHTTP directly.
DWC_ETYPE_FATAL Since this corresponds to FatalError, you must prompt the user to turn the power OFF or to return to the Wii menu. Display the error code.
DWC_ETYPE_NUM

dwc_base Error Code Elements for Debugging

enum  {
    DWC_ECODE_SEQ_LOGIN                          (-60000)
    DWC_ECODE_SEQ_FRIEND                         (-70000)
    DWC_ECODE_SEQ_MATCH                          (-80000)
    DWC_ECODE_SEQ_ETC                            (-90000)
    DWC_ECODE_GS_GP                               (-1000)
    DWC_ECODE_GS_PERS                             (-2000)
    DWC_ECODE_GS_STATS                            (-3000)
    DWC_ECODE_GS_QR2                              (-4000)
    DWC_ECODE_GS_SB                               (-5000)
    DWC_ECODE_GS_NN                               (-6000)
    DWC_ECODE_GS_GT2                              (-7000)
    DWC_ECODE_GS_HTTP                             (-8000)
    DWC_ECODE_GS_ETC                              (-9000)
    DWC_ECODE_TYPE_NETWORK                         ( -10)
    DWC_ECODE_TYPE_SERVER                          ( -20)
    DWC_ECODE_TYPE_DNS                             ( -30)
    DWC_ECODE_TYPE_DATA                            ( -40)
    DWC_ECODE_TYPE_SOCKET                          ( -50)
    DWC_ECODE_TYPE_BIND                            ( -60)
    DWC_ECODE_TYPE_TIMEOUT                         ( -70)
    DWC_ECODE_TYPE_PEER                            ( -80)
    DWC_ECODE_TYPE_CONN_OVER                       (-100)
    DWC_ECODE_TYPE_STATS_AUTH                      (-200)
    DWC_ECODE_TYPE_STATS_LOAD                      (-210)
    DWC_ECODE_TYPE_STATS_SAVE                      (-220)
    DWC_ECODE_TYPE_NOT_FRIEND                      (-400)
    DWC_ECODE_TYPE_OTHER                           (-410)
    DWC_ECODE_TYPE_MUCH_FAILURE                    (-420)
    DWC_ECODE_TYPE_SC_CL_FAIL                      (-430)
    DWC_ECODE_TYPE_CLOSE                           (-600)
    DWC_ECODE_TYPE_TRANS_HEADER                    (-610)
    DWC_ECODE_TYPE_TRANS_BODY                      (-620)
    DWC_ECODE_TYPE_TRANS_SEND                      (-630)
    DWC_ECODE_TYPE_TRANS_UNKNOWN_PEER              (-640)
    DWC_ECODE_TYPE_AC_FATAL                        (-700)
    DWC_ECODE_TYPE_OPEN_FILE                       (-800)
    DWC_ECODE_TYPE_INVALID_POST                    (-810)
    DWC_ECODE_TYPE_REQ_INVALID                     (-820)
    DWC_ECODE_TYPE_UNSPECIFIED                     (-830)
    DWC_ECODE_TYPE_BUFF_OVER                       (-840)
    DWC_ECODE_TYPE_PARSE_URL                       (-850)
    DWC_ECODE_TYPE_BAD_RESPONSE                    (-860)
    DWC_ECODE_TYPE_REJECTED                        (-870)
    DWC_ECODE_TYPE_FILE_RW                         (-880)
    DWC_ECODE_TYPE_INCOMPLETE                      (-890)
    DWC_ECODE_TYPE_TO_BIG                          (-900)
    DWC_ECODE_TYPE_ENCRYPTION                      (-910)
    DWC_ECODE_TYPE_ALLOC                             (-1)
    DWC_ECODE_TYPE_PARAM                             (-2)
    DWC_ECODE_TYPE_SO_SOCKET                         (-3)
    DWC_ECODE_TYPE_NOT_INIT                          (-4)
    DWC_ECODE_TYPE_DUP_INIT                          (-5)
    DWC_ECODE_TYPE_WM_INIT                           (-6)
    DWC_ECODE_TYPE_UNEXPECTED                        (-9)
    DWC_ECODE_SEQ_ADDINS                           (-30000)
    DWC_ECODE_FUNC_PROF                            (-3000)
    DWC_ECODE_FUNC_ND                              (-1000)
    DWC_ECODE_TYPE_ND_ALLOC                        ( -1)
    DWC_ECODE_TYPE_ND_FATAL                        ( -9)
    DWC_ECODE_TYPE_ND_STATE                        (-10)
    DWC_ECODE_TYPE_ND_HTTP                         (-20)
    DWC_ECODE_TYPE_ND_PARAM                        (-30)
    DWC_ECODE_TYPE_ND_CANCEL                       (-40)
    DWC_ECODE_TYPE_ND_SERVER_PARAM                 (-101)
    DWC_ECODE_TYPE_ND_SERVER_SERVICE               (-102)
    DWC_ECODE_TYPE_ND_SERVER_INVALIDTOKEN          (-103)
    DWC_ECODE_TYPE_ND_SERVER_TOKENEXPIRED          (-104)
    DWC_ECODE_TYPE_ND_SERVER_NOCONTENTS            (-105)
    DWC_ECODE_TYPE_ND_SERVER_ATTR                  (-106)
    DWC_ECODE_TYPE_ND_SERVER_CONTENTSEXPIRED       (-107)
    DWC_ECODE_TYPE_ND_SERVER_INVALIDAP             (-108)
    DWC_ECODE_TYPE_ND_SERVER_DATABASE              (-109)
    DWC_ECODE_TYPE_ND_SERVER_PASSWORD              (-110)
    DWC_ECODE_TYPE_PROF_CONNERR                    ( -10)
    DWC_ECODE_TYPE_PROF_PARSEERR                   ( -20)
    DWC_ECODE_TYPE_PROF_OTHERERR                   ( -30)
};
DWC_ECODE_SEQ_LOGIN Error during login processing.
DWC_ECODE_SEQ_FRIEND Error during friend management processing.
DWC_ECODE_SEQ_MATCH Error during the matchmaking process.
DWC_ECODE_SEQ_ETC Error during processing that is not listed.
DWC_ECODE_GS_GP GameSpyGP error.
DWC_ECODE_GS_PERS GameSpyPersistent error.
DWC_ECODE_GS_STATS GameSpyStats error.
DWC_ECODE_GS_QR2 GameSpyQR2 error.
DWC_ECODE_GS_SB GameSpyServerBrowsing error.
DWC_ECODE_GS_NN GameSpyNatNegotiation error.
DWC_ECODE_GS_GT2 GameSpygt2 error.
DWC_ECODE_GS_HTTP GameSpyHTTP error.
DWC_ECODE_GS_ETC Other GameSpy SDK error.
DWC_ECODE_TYPE_NETWORK Network failure.
DWC_ECODE_TYPE_SERVER GameSpy server failure.
DWC_ECODE_TYPE_DNS DNS failure.
DWC_ECODE_TYPE_DATA Received invalid data.
DWC_ECODE_TYPE_SOCKET Socket communication error.
DWC_ECODE_TYPE_BIND Socket bind error.
DWC_ECODE_TYPE_TIMEOUT Timeout has occurred.
DWC_ECODE_TYPE_PEER Problem with one-on-one communication.
DWC_ECODE_TYPE_CONN_OVER Exceeded the number of connections.
DWC_ECODE_TYPE_STATS_AUTH STATS server login error.
DWC_ECODE_TYPE_STATS_LOAD STATS server data load error.
DWC_ECODE_TYPE_STATS_SAVE STATS server data save error.
DWC_ECODE_TYPE_NOT_FRIEND The specified partner is not a registered friend.
DWC_ECODE_TYPE_OTHER The partner disconnected communications (usually occurs during server-client matchmaking).
DWC_ECODE_TYPE_MUCH_FAILURE Failed NAT negotiations for the specified number of times.
DWC_ECODE_TYPE_SC_CL_FAIL The server-client matchmaking client failed to connect.
DWC_ECODE_TYPE_CLOSE Error while closing connections.
DWC_ECODE_TYPE_TRANS_HEADER Reliable data was received in an impossible reception state.
DWC_ECODE_TYPE_TRANS_BODY Receive buffer overflow.
DWC_ECODE_TYPE_TRANS_SEND Reliable transfer failure
DWC_ECODE_TYPE_TRANS_UNKNOWN_PEER Receipt from a gt2 connection that is unrecognized by the local host.
DWC_ECODE_TYPE_AC_FATAL Error group for AC during AC processing. In this case, the lower-order digits represent a dedicated state value.
DWC_ECODE_TYPE_OPEN_FILE Failed to open GHTTP file.
DWC_ECODE_TYPE_INVALID_POST Invalid GHTTP transmission.
DWC_ECODE_TYPE_REQ_INVALID GHTTP file name or similar data is invalid.
DWC_ECODE_TYPE_UNSPECIFIED Unspecified GHTTP error.
DWC_ECODE_TYPE_BUFF_OVER GHTTP buffer overflow.
DWC_ECODE_TYPE_PARSE_URL GHTTPURL analysis error.
DWC_ECODE_TYPE_BAD_RESPONSE Error analyzing the response from the GHTTP server.
DWC_ECODE_TYPE_REJECTED Rejection of requests or other messages from a GHTTP server.
DWC_ECODE_TYPE_FILE_RW GHTTP local file read/write error.
DWC_ECODE_TYPE_INCOMPLETE GHTTP download aborted.
DWC_ECODE_TYPE_TO_BIG Download not permitted because the GHTTP file is too large.
DWC_ECODE_TYPE_ENCRYPTION GHTTP encryption error.
DWC_ECODE_TYPE_ALLOC Failed to allocate memory.
DWC_ECODE_TYPE_PARAM Parameter error.
DWC_ECODE_TYPE_SO_SOCKET A GameSpy gt2 socket error was caused by an SO error.
DWC_ECODE_TYPE_NOT_INIT The socket library is not initialized.
DWC_ECODE_TYPE_DUP_INIT The library has been initialized twice.
DWC_ECODE_TYPE_WM_INIT Failure to initialize WM.
DWC_ECODE_TYPE_UNEXPECTED An unexpected state or an unknown GameSpy error has occurred.
DWC_ECODE_SEQ_ADDINS Extended feature error.
DWC_ECODE_FUNC_PROF The region for the name-check feature
DWC_ECODE_FUNC_ND Region used for DWC_Nd.
DWC_ECODE_TYPE_ND_ALLOC Failed to allocate memory.
DWC_ECODE_TYPE_ND_FATAL Used for other fatal errors.
DWC_ECODE_TYPE_ND_STATE A function was called in a state in which it cannot be called.
DWC_ECODE_TYPE_ND_HTTP HTTP communication failure.
DWC_ECODE_TYPE_ND_PARAM Invalid parameter was passed to the function.
DWC_ECODE_TYPE_ND_CANCEL Asynchronous processing has been canceled.
DWC_ECODE_TYPE_ND_SERVER_PARAM Invalid parameter has been sent to the server.
DWC_ECODE_TYPE_ND_SERVER_SERVICE Unregistered service.
DWC_ECODE_TYPE_ND_SERVER_INVALIDTOKEN Illegal token (service locator information).
DWC_ECODE_TYPE_ND_SERVER_TOKENEXPIRED Expired token (service locator information).
DWC_ECODE_TYPE_ND_SERVER_NOCONTENTS No content present.
DWC_ECODE_TYPE_ND_SERVER_ATTR Attribute does not match.
DWC_ECODE_TYPE_ND_SERVER_CONTENTSEXPIRED Expired content.
DWC_ECODE_TYPE_ND_SERVER_INVALIDAP Access from an access point that is not a service target.
DWC_ECODE_TYPE_ND_SERVER_DATABASE Cannot connect to database (problem with the download server).
DWC_ECODE_TYPE_ND_SERVER_PASSWORD Password does not match.
DWC_ECODE_TYPE_PROF_CONNERR Abnormal communications with the server used for illegal character string check.
DWC_ECODE_TYPE_PROF_PARSEERR Unable to correctly parse a character string from the server used for illegal character string check.
DWC_ECODE_TYPE_PROF_OTHERERR Some other error occurred in communications with the server used for illegal character string check.

Friend's Communication Status (Redefine and use the GPEnum Status + alpha)

enum  {
    DWC_STATUS_OFFLINE           0
    DWC_STATUS_ONLINE
    DWC_STATUS_PLAYING
    DWC_STATUS_MATCH_ANYBODY
    DWC_STATUS_MATCH_FRIEND
    DWC_STATUS_MATCH_SC_CL
    DWC_STATUS_MATCH_SC_SV
    DWC_STATUS_NUM
};
DWC_STATUS_OFFLINE Offline.
DWC_STATUS_ONLINE Online (logged on to the GP server).
DWC_STATUS_PLAYING Playing the game.
DWC_STATUS_MATCH_ANYBODY Currently performing friend-unspecified peer matchmaking.
DWC_STATUS_MATCH_FRIEND Currently performing friend-specified peer matchmaking.
DWC_STATUS_MATCH_SC_CL Client that is in server-client matchmaking.
DWC_STATUS_MATCH_SC_SV Server that is in server-client matchmaking.
DWC_STATUS_NUM

Friend Management Status

enum DWCFriendState {
    DWC_FRIEND_STATE_INIT           0
    DWC_FRIEND_STATE_PERS_LOGIN
    DWC_FRIEND_STATE_LOGON
    DWC_FRIEND_STATE_NUM
};
DWC_FRIEND_STATE_INIT Initial state.
DWC_FRIEND_STATE_PERS_LOGIN Currently logging on to the Persistent server and synchronizing friend roster.
DWC_FRIEND_STATE_LOGON Currently logged on to the Persistent server.
DWC_FRIEND_STATE_NUM

Local Friend Roster and GP Friend Roster Synchronization States

enum  {
    DWC_BUDDY_UPDATE_STATE_WAIT         0
    DWC_BUDDY_UPDATE_STATE_CHECK
    DWC_BUDDY_UPDATE_STATE_PSEARCH
    DWC_BUDDY_UPDATE_STATE_COMPLETE
    DWC_BUDDY_UPDATE_STATE_NUM
};
DWC_BUDDY_UPDATE_STATE_WAIT Waiting for friend roster to complete download.
DWC_BUDDY_UPDATE_STATE_CHECK Currently checking friend roster.
DWC_BUDDY_UPDATE_STATE_PSEARCH Currently searching for profile.
DWC_BUDDY_UPDATE_STATE_COMPLETE Friend roster synchronization complete.
DWC_BUDDY_UPDATE_STATE_NUM

Enumerated Type Indicating the Field Type

enum DWCGdbFieldType {
    DWC_GDB_FIELD_TYPE_BYTE
    DWC_GDB_FIELD_TYPE_SHORT
    DWC_GDB_FIELD_TYPE_INT
    DWC_GDB_FIELD_TYPE_FLOAT
    DWC_GDB_FIELD_TYPE_ASCII_STRING
    DWC_GDB_FIELD_TYPE_UNICODE_STRING
    DWC_GDB_FIELD_TYPE_BOOLEAN
    DWC_GDB_FIELD_TYPE_DATE_AND_TIME
    DWC_GDB_FIELD_TYPE_BINARY_DATA
    DWC_GDB_FIELD_TYPE_NUM_FIELD_TYPES
};
DWC_GDB_FIELD_TYPE_BYTE Unsigned 1-byte integer.
DWC_GDB_FIELD_TYPE_SHORT Signed 2-byte integer.
DWC_GDB_FIELD_TYPE_INT Signed 4-byte integer.
DWC_GDB_FIELD_TYPE_FLOAT Floating-point, 8-byte number.
DWC_GDB_FIELD_TYPE_ASCII_STRING String of 1-byte characters.
DWC_GDB_FIELD_TYPE_UNICODE_STRING String of 2-byte characters.
DWC_GDB_FIELD_TYPE_BOOLEAN Boolean value.
DWC_GDB_FIELD_TYPE_DATE_AND_TIME Time shown in UnixTime.
DWC_GDB_FIELD_TYPE_BINARY_DATA Binary data.
DWC_GDB_FIELD_TYPE_NUM_FIELD_TYPES

Enumerated Type Indicating Errors

enum DWCGdbError {
    DWC_GDB_ERROR_NONE                    0
    DWC_GDB_ERROR_OUT_OF_MEMORY           1
    DWC_GDB_ERROR_NOT_AVAILABLE           2
    DWC_GDB_ERROR_CORE_SHUTDOWN           3
    DWC_GDB_ERROR_NOT_LOGIN               4
    DWC_GDB_ERROR_NOT_AUTHENTICATED       5
    DWC_GDB_ERROR_BAD_INPUT               6
    DWC_GDB_ERROR_BAD_TABLENAME           7
    DWC_GDB_ERROR_BAD_FIELDS              8
    DWC_GDB_ERROR_BAD_NUM_FIELDS          9
    DWC_GDB_ERROR_BAD_FIELD_NAME          10
    DWC_GDB_ERROR_BAD_FIELD_TYPE          11
    DWC_GDB_ERROR_BAD_FIELD_VALUE         12
    DWC_GDB_ERROR_BAD_OFFSET              13
    DWC_GDB_ERROR_BAD_MAX                 14
    DWC_GDB_ERROR_BAD_RECORDIDS           15
    DWC_GDB_ERROR_BAD_NUM_RECORDIDS       16
    DWC_GDB_ERROR_UNKNOWN                 17
    DWC_GDB_ERROR_ALREADY_INITIALIZED     18
    DWC_GDB_ERROR_NOT_INITIALIZED         19
    DWC_GDB_ERROR_IN_ASYNC_PROCESS        20
    DWC_GDB_ERROR_GHTTP                   21
    DWC_GDB_ERROR_IN_DWC_ERROR            22
};
DWC_GDB_ERROR_NONE Normal termination.
DWC_GDB_ERROR_OUT_OF_MEMORY Could not allocate memory from the allocator given in DWC_Init.
DWC_GDB_ERROR_NOT_AVAILABLE
DWC_GDB_ERROR_CORE_SHUTDOWN
DWC_GDB_ERROR_NOT_LOGIN Not properly logged on to Nintendo Wi-Fi Connection.
DWC_GDB_ERROR_NOT_AUTHENTICATED Not properly logged on to Nintendo Wi-Fi Connection.
DWC_GDB_ERROR_BAD_INPUT
DWC_GDB_ERROR_BAD_TABLENAME
DWC_GDB_ERROR_BAD_FIELDS
DWC_GDB_ERROR_BAD_NUM_FIELDS
DWC_GDB_ERROR_BAD_FIELD_NAME
DWC_GDB_ERROR_BAD_FIELD_TYPE
DWC_GDB_ERROR_BAD_FIELD_VALUE
DWC_GDB_ERROR_BAD_OFFSET
DWC_GDB_ERROR_BAD_MAX
DWC_GDB_ERROR_BAD_RECORDIDS
DWC_GDB_ERROR_BAD_NUM_RECORDIDS
DWC_GDB_ERROR_UNKNOWN
DWC_GDB_ERROR_ALREADY_INITIALIZED Already initialized.
DWC_GDB_ERROR_NOT_INITIALIZED Not initialized.
DWC_GDB_ERROR_IN_ASYNC_PROCESS Asynchronous processing is in progress.
DWC_GDB_ERROR_GHTTP GHTTP error.
DWC_GDB_ERROR_IN_DWC_ERROR DWC error. Take appropriate steps for error handling.

Enumerated Type Indicating the Result of Asynchronous Process

enum DWCGdbAsyncResult {
    DWC_GDB_ASYNC_RESULT_NONE                      0
    DWC_GDB_ASYNC_RESULT_SUCCESS                   1
    DWC_GDB_ASYNC_RESULT_SECRET_KEY_INVALID        2
    DWC_GDB_ASYNC_RESULT_SERVICE_DISABLED          3
    DWC_GDB_ASYNC_RESULT_CONNECTION_TIMEOUT        4
    DWC_GDB_ASYNC_RESULT_CONNECTION_ERROR          5
    DWC_GDB_ASYNC_RESULT_MALFORMED_RESPONSE        6
    DWC_GDB_ASYNC_RESULT_OUT_OF_MEMORY             7
    DWC_GDB_ASYNC_RESULT_DATABASE_UNAVAILABLE      8
    DWC_GDB_ASYNC_RESULT_LOGIN_TICKET_INVALID      9
    DWC_GDB_ASYNC_RESULT_LOGIN_TICKET_EXPIRED      10
    DWC_GDB_ASYNC_RESULT_TABLE_NOT_FOUND           11
    DWC_GDB_ASYNC_RESULT_RECORD_NOT_FOUND          12
    DWC_GDB_ASYNC_RESULT_FIELD_NOT_FOUND           13
    DWC_GDB_ASYNC_RESULT_FIELD_TYPE_INVALID        14
    DWC_GDB_ASYNC_RESULT_NO_PERMISSION             15
    DWC_GDB_ASYNC_RESULT_RECORD_LIMIT_REACHED      16
    DWC_GDB_ASYNC_RESULT_ALREADY_RATED             17
    DWC_GDB_ASYNC_RESULT_NOT_RATEABLE              18
    DWC_GDB_ASYNC_RESULT_NOT_OWNED                 19
    DWC_GDB_ASYNC_RESULT_FILTER_INVALID            20
    DWC_GDB_ASYNC_RESULT_SORT_INVALID              21
    DWC_GDB_ASYNC_RESULT_UNKNOWN_ERROR             22
    DWC_GDB_ASYNC_RESULT_BAD_HTTP_METHOD           23
    DWC_GDB_ASYNC_RESULT_BAD_FILE_COUNT            24
    DWC_GDB_ASYNC_RESULT_MISSING_PARAMETER         25
    DWC_GDB_ASYNC_RESULT_FILE_NOT_FOUND            26
    DWC_GDB_ASYNC_RESULT_FILE_TOO_LARGE            27
    DWC_GDB_ASYNC_RESULT_FILE_UNKNOWN_ERROR        28
    DWC_GDB_ASYNC_RESULT_GHTTP_ERROR               29
    DWC_GDB_ASYNC_RESULT_TARGET_FILTER_INVALID     30
    DWC_GDB_ASYNC_RESULT_SERVER_ERROR              31
};
DWC_GDB_ASYNC_RESULT_NONE The asynchronous process is not done yet.
DWC_GDB_ASYNC_RESULT_SUCCESS Process succeeded.
DWC_GDB_ASYNC_RESULT_SECRET_KEY_INVALID
DWC_GDB_ASYNC_RESULT_SERVICE_DISABLED
DWC_GDB_ASYNC_RESULT_CONNECTION_TIMEOUT
DWC_GDB_ASYNC_RESULT_CONNECTION_ERROR
DWC_GDB_ASYNC_RESULT_MALFORMED_RESPONSE
DWC_GDB_ASYNC_RESULT_OUT_OF_MEMORY
DWC_GDB_ASYNC_RESULT_DATABASE_UNAVAILABLE
DWC_GDB_ASYNC_RESULT_LOGIN_TICKET_INVALID
DWC_GDB_ASYNC_RESULT_LOGIN_TICKET_EXPIRED
DWC_GDB_ASYNC_RESULT_TABLE_NOT_FOUND
DWC_GDB_ASYNC_RESULT_RECORD_NOT_FOUND
DWC_GDB_ASYNC_RESULT_FIELD_NOT_FOUND
DWC_GDB_ASYNC_RESULT_FIELD_TYPE_INVALID
DWC_GDB_ASYNC_RESULT_NO_PERMISSION
DWC_GDB_ASYNC_RESULT_RECORD_LIMIT_REACHED
DWC_GDB_ASYNC_RESULT_ALREADY_RATED
DWC_GDB_ASYNC_RESULT_NOT_RATEABLE
DWC_GDB_ASYNC_RESULT_NOT_OWNED
DWC_GDB_ASYNC_RESULT_FILTER_INVALID
DWC_GDB_ASYNC_RESULT_SORT_INVALID
DWC_GDB_ASYNC_RESULT_UNKNOWN_ERROR
DWC_GDB_ASYNC_RESULT_BAD_HTTP_METHOD
DWC_GDB_ASYNC_RESULT_BAD_FILE_COUNT
DWC_GDB_ASYNC_RESULT_MISSING_PARAMETER
DWC_GDB_ASYNC_RESULT_FILE_NOT_FOUND
DWC_GDB_ASYNC_RESULT_FILE_TOO_LARGE
DWC_GDB_ASYNC_RESULT_FILE_UNKNOWN_ERROR
DWC_GDB_ASYNC_RESULT_GHTTP_ERROR GHTTP error.
DWC_GDB_ASYNC_RESULT_TARGET_FILTER_INVALID
DWC_GDB_ASYNC_RESULT_SERVER_ERROR

Enumerated Type Indicating State of DWCGdb Library

enum DWCGdbState {
    DWC_GDB_STATE_UNINITIALIZED
    DWC_GDB_STATE_IDLE
    DWC_GDB_STATE_IN_ASYNC_PROCESS
    DWC_GDB_STATE_ERROR_OCCURED
};
DWC_GDB_STATE_UNINITIALIZED Uninitialized.
DWC_GDB_STATE_IDLE Initialization has completed; asynchronous process is not running.
DWC_GDB_STATE_IN_ASYNC_PROCESS Asynchronous process is running.
DWC_GDB_STATE_ERROR_OCCURED An error has occurred.

Enumerators Indicating the Authentication Server Type

enum DWCAUTHSERVER {
    DWC_AUTHSERVER_DEBUG       0
    DWC_AUTHSERVER_RELEASE
    DWC_AUTHSERVER_TEST
};
DWC_AUTHSERVER_DEBUG Server for development.
DWC_AUTHSERVER_RELEASE Server for products.
DWC_AUTHSERVER_TEST Do not use.

Status Variables

enum DWCLanMatchState {
    DWC_INIT_CALLED
    DWC_TEMP_CLIENT
    DWC_TEMP_SERVER
    DWC_CLIENT
    DWC_SERVER
    DWC_WAIT_CONNECT2SERVER
    DWC_WAIT_CONNECT2CLIENT
    DWC_WAIT_COMPLETE
    DWC_COMPLETE
};
DWC_INIT_CALLED
DWC_TEMP_CLIENT
DWC_TEMP_SERVER
DWC_CLIENT
DWC_SERVER
DWC_WAIT_CONNECT2SERVER
DWC_WAIT_CONNECT2CLIENT
DWC_WAIT_COMPLETE
DWC_COMPLETE

Types of Send Data

enum DWCPacketType {
    DWC_MESH_CONSTRUCT
    DWC_MESH_COMPLETE
    DWC_MATCHING_COMPLETE
};
DWC_MESH_CONSTRUCT
DWC_MESH_COMPLETE
DWC_MATCHING_COMPLETE

Login Progress Status Enumerators

enum DWCLoginState {
    DWC_LOGIN_STATE_INIT            0
    DWC_LOGIN_STATE_REMOTE_AUTH
    DWC_LOGIN_STATE_CONNECTING
    DWC_LOGIN_STATE_GPGETINFO
    DWC_LOGIN_STATE_GPSETINFO
    DWC_LOGIN_STATE_CONNECTED
    DWC_LOGIN_STATE_NUM
};
DWC_LOGIN_STATE_INIT Initial state.
DWC_LOGIN_STATE_REMOTE_AUTH Currently performing remote authentication.
DWC_LOGIN_STATE_CONNECTING Currently connecting to GP server.
DWC_LOGIN_STATE_GPGETINFO When getting lastname after logging into the GP server.
DWC_LOGIN_STATE_GPSETINFO The lastname setting when logged on to the GP server for the first time.
DWC_LOGIN_STATE_CONNECTED Connection completed.
DWC_LOGIN_STATE_NUM

DWC Network Status Enumerators

enum DWCState {
    DWC_STATE_INIT                0
    DWC_STATE_AVAILABLE_CHECK
    DWC_STATE_LOGIN
    DWC_STATE_ONLINE
    DWC_STATE_UPDATE_SERVERS
    DWC_STATE_MATCHING
    DWC_STATE_CONNECTED
    DWC_STATE_NUM
};
DWC_STATE_INIT Initial state.
DWC_STATE_AVAILABLE_CHECK Checking game availability state.
DWC_STATE_LOGIN Logging in.
DWC_STATE_ONLINE Login completed and online.
DWC_STATE_UPDATE_SERVERS Currently performing the friend roster synchronization process.
DWC_STATE_MATCHING Currently matchmaking.
DWC_STATE_CONNECTED Matching has completed, and a mesh network has been created.
DWC_STATE_NUM

Matchmaking State Enumerator

enum DWCMatchState {
    DWC_MATCH_STATE_INIT                       0
    DWC_MATCH_STATE_CL_WAITING
    DWC_MATCH_STATE_CL_SEARCH_HOST
    DWC_MATCH_STATE_CL_WAIT_RESV
    DWC_MATCH_STATE_CL_SEARCH_EVAL_HOST
    DWC_MATCH_STATE_CL_NN
    DWC_MATCH_STATE_CL_GT2
    DWC_MATCH_STATE_CL_CANCEL_SYN
    DWC_MATCH_STATE_CL_SYN
    DWC_MATCH_STATE_CL_SVDOWN_1
    DWC_MATCH_STATE_CL_SVDOWN_2
    DWC_MATCH_STATE_CL_SVDOWN_3
    DWC_MATCH_STATE_CL_SEARCH_GROUPID_HOST
    DWC_MATCH_STATE_SV_WAITING
    DWC_MATCH_STATE_SV_OWN_NN
    DWC_MATCH_STATE_SV_OWN_GT2
    DWC_MATCH_STATE_SV_WAIT_CL_LINK
    DWC_MATCH_STATE_SV_CANCEL_SYN
    DWC_MATCH_STATE_SV_CANCEL_SYN_WAIT
    DWC_MATCH_STATE_SV_SYN
    DWC_MATCH_STATE_SV_SYN_WAIT
    DWC_MATCH_STATE_WAIT_CLOSE
    DWC_MATCH_STATE_SEARCH_OWN
    DWC_MATCH_STATE_SV_SYN_CLOSE_WAIT
    DWC_MATCH_STATE_NUM
};
DWC_MATCH_STATE_INIT Initial state.
DWC_MATCH_STATE_CL_WAITING Waiting.
DWC_MATCH_STATE_CL_SEARCH_HOST Searching for available host (only when no friend has been specified).
DWC_MATCH_STATE_CL_WAIT_RESV Waiting for response from server about reservation.
DWC_MATCH_STATE_CL_SEARCH_EVAL_HOST Searching for a host to evaluate.
DWC_MATCH_STATE_CL_NN Currently running NAT negotiation.
DWC_MATCH_STATE_CL_GT2 Currently establishing GT2 connection.
DWC_MATCH_STATE_CL_CANCEL_SYN Currently adjusting matchmaking cancellation synchronization between server and client.
DWC_MATCH_STATE_CL_SYN Currently adjusting matchmaking completion synchronization.
DWC_MATCH_STATE_CL_SVDOWN_1 Currently detecting server down.
DWC_MATCH_STATE_CL_SVDOWN_2 Currently detecting server down, 2.
DWC_MATCH_STATE_CL_SVDOWN_3 Currently detecting server down, 3.
DWC_MATCH_STATE_CL_SEARCH_GROUPID_HOST Search for host based on group ID.
DWC_MATCH_STATE_SV_WAITING Waiting.
DWC_MATCH_STATE_SV_OWN_NN Currently running NAT negotiation with client.
DWC_MATCH_STATE_SV_OWN_GT2 Currently establishing GT2 negotiation with client.
DWC_MATCH_STATE_SV_WAIT_CL_LINK Waiting for connection between clients to complete.
DWC_MATCH_STATE_SV_CANCEL_SYN Waiting for SYN-ACK related to matchmaking cancellation synchronization between server and client.
DWC_MATCH_STATE_SV_CANCEL_SYN_WAIT Currently waiting for termination of matchmaking cancellation synchronization between server and client.
DWC_MATCH_STATE_SV_SYN Waiting for SYN-ACK related to matchmaking termination synchronization.
DWC_MATCH_STATE_SV_SYN_WAIT Waiting for termination of matchmaking termination synchronization.
DWC_MATCH_STATE_WAIT_CLOSE Waiting for negotiation to close.
DWC_MATCH_STATE_SEARCH_OWN Searching for the local host's information (previously named DWC_MATCH_STATE_CL_SEARCH_OWN).
DWC_MATCH_STATE_SV_SYN_CLOSE_WAIT The wait time after the CLOSE command is sent.
DWC_MATCH_STATE_NUM

Matchmaking Type Enumerators

enum  {
    DWC_MATCH_TYPE_ANYBODY     0
    DWC_MATCH_TYPE_FRIEND
    DWC_MATCH_TYPE_SC_SV
    DWC_MATCH_TYPE_SC_CL
    DWC_MATCH_TYPE_NUM
};
DWC_MATCH_TYPE_ANYBODY Pair matchmaking with friend unspecified.
DWC_MATCH_TYPE_FRIEND Peer matchmaking with friend specified.
DWC_MATCH_TYPE_SC_SV Server side of server-client matchmaking.
DWC_MATCH_TYPE_SC_CL Client side of server-client matchmaking.
DWC_MATCH_TYPE_NUM

Suspend Callback Enumerators

enum DWCSuspendResult {
    DWC_SUSPEND_SUCCESS     0
    DWC_SUSPEND_TIMEOUT
    DWC_SUSPEND_NUM
};
DWC_SUSPEND_SUCCESS Completed successfully.
DWC_SUSPEND_TIMEOUT Timed out (currently, this is not used).
DWC_SUSPEND_NUM

Connection Topology Enumerators

enum DWCTopologyType {
    DWC_TOPOLOGY_TYPE_HYBRID       0
    DWC_TOPOLOGY_TYPE_STAR
    DWC_TOPOLOGY_TYPE_FULLMESH
    DWC_TOPOLOGY_TYPE_NUM
};
DWC_TOPOLOGY_TYPE_HYBRID Hybrid type.
DWC_TOPOLOGY_TYPE_STAR Star type.
DWC_TOPOLOGY_TYPE_FULLMESH Full-mesh type.
DWC_TOPOLOGY_TYPE_NUM

ingamesn Check Result Enumerator

enum DWCIngamesnCheckResult {
    DWC_INGAMESN_NOT_CHECKED     0
    DWC_INGAMESN_VALID           1
    DWC_INGAMESN_INVALID         2
};
DWC_INGAMESN_NOT_CHECKED Unchecked.
DWC_INGAMESN_VALID Enabled.
DWC_INGAMESN_INVALID Disabled.

Enumeration Type for the Status of the Nintendo Authentication Server Authentication Process

enum DWCNasLoginState {
    DWC_NASLOGIN_STATE_DIRTY        0
    DWC_NASLOGIN_STATE_IDLE
    DWC_NASLOGIN_STATE_HTTP
    DWC_NASLOGIN_STATE_SUCCESS
    DWC_NASLOGIN_STATE_ERROR
    DWC_NASLOGIN_STATE_CANCELED
    DWC_NASLOGIN_STATE_MAX
};
DWC_NASLOGIN_STATE_DIRTY Authentication process has not been initialized.
DWC_NASLOGIN_STATE_IDLE Authentication process has not started. Waiting state.
DWC_NASLOGIN_STATE_HTTP The HTTP network communication for the authentication process is running.
DWC_NASLOGIN_STATE_SUCCESS Authentication process was successful.
DWC_NASLOGIN_STATE_ERROR Authentication process failed.
DWC_NASLOGIN_STATE_CANCELED Authentication process was canceled.
DWC_NASLOGIN_STATE_MAX

Download Library State

enum DWCNdState {
    DWC_ND_STATE_NOTINITIALIZED
    DWC_ND_STATE_READY
    DWC_ND_STATE_BUSY
    DWC_ND_STATE_COMPLETE
    DWC_ND_STATE_ERROR
    DWC_ND_STATE_MAX
};
DWC_ND_STATE_NOTINITIALIZED Download library not initialized.
DWC_ND_STATE_READY Initialization is complete, and other download library functions can be called.
DWC_ND_STATE_BUSY Currently running asynchronous processing.
DWC_ND_STATE_COMPLETE Asynchronous processing has completed normally.
DWC_ND_STATE_ERROR An error has occurred during asynchronous processing and the process has ended.
DWC_ND_STATE_MAX

Download Library Error Enumerator

enum DWCNdError {
    DWC_ND_ERROR_NONE
    DWC_ND_ERROR_ALLOC
    DWC_ND_ERROR_STATE
    DWC_ND_ERROR_HTTP
    DWC_ND_ERROR_BUFFULL
    DWC_ND_ERROR_PARAM
    DWC_ND_ERROR_CANCELED
    DWC_ND_ERROR_DLSERVER
    DWC_ND_ERROR_FATAL
    DWC_ND_ERROR_MAX
};
DWC_ND_ERROR_NONE The executing process has completed.
DWC_ND_ERROR_ALLOC Memory allocation failed.
DWC_ND_ERROR_STATE Function has been called in a state in which it cannot be called.
DWC_ND_ERROR_HTTP An HTTP communications error occurred.
DWC_ND_ERROR_BUFFULL (Internal error) Insufficient space in Download buffer.
DWC_ND_ERROR_PARAM Error due to an invalid parameter.
DWC_ND_ERROR_CANCELED Process cancellation has finished.
DWC_ND_ERROR_DLSERVER Server returned an error code.
DWC_ND_ERROR_FATAL Undefined fatal error has occurred.
DWC_ND_ERROR_MAX

Download Library Progress Enumerator

enum DWCNdCallbackReason {
    DWC_ND_CBREASON_INITIALIZE
    DWC_ND_CBREASON_GETFILELISTNUM
    DWC_ND_CBREASON_GETFILELIST
    DWC_ND_CBREASON_GETFILE
    DWC_ND_CBREASON_CLEANUP
    DWC_ND_CBREASON_MAX
};
DWC_ND_CBREASON_INITIALIZE Notification function was called while the Download library was initializing.
DWC_ND_CBREASON_GETFILELISTNUM Notification callback was called while the total number of downloadable files was being downloaded.
DWC_ND_CBREASON_GETFILELIST Notification callback was called while the file information list was being downloaded.
DWC_ND_CBREASON_GETFILE Notification callback was called while a file was being downloaded.
DWC_ND_CBREASON_CLEANUP Called when cleanup was finished.
DWC_ND_CBREASON_MAX

Illegal String Check State

enum DWCProfState {
    DWC_PROF_STATE_NOT_INITIALIZED     0
    DWC_PROF_STATE_OPERATING
    DWC_PROF_STATE_SUCCESS
    DWC_PROF_STATE_FAIL
};
DWC_PROF_STATE_NOT_INITIALIZED Uninitialized.
DWC_PROF_STATE_OPERATING Currently performing HTTP communications.
DWC_PROF_STATE_SUCCESS Illegal character string check succeeded.
DWC_PROF_STATE_FAIL Illegal character string check failed.

Constants Indicating Ascending and Descending Order of the Ranking List to be Retrieved

enum  {
    DWC_RNK_ORDER_ASC    	0
    DWC_RNK_ORDER_DES    	1
};
DWC_RNK_ORDER_ASC Ascending order.
DWC_RNK_ORDER_DES Descending order.

Error Codes

enum DWCRnkError {
    DWC_RNK_SUCCESS                             0
    DWC_RNK_IN_ERROR
    DWC_RNK_ERROR_INVALID_PARAMETER
    DWC_RNK_ERROR_INIT_ALREADYINITIALIZED
    DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE
    DWC_RNK_ERROR_INIT_INVALID_INITDATA
    DWC_RNK_ERROR_INIT_INVALID_USERDATA
    DWC_RNK_ERROR_PUT_NOTREADY
    DWC_RNK_ERROR_PUT_INVALID_KEY
    DWC_RNK_ERROR_PUT_NOMEMORY
    DWC_RNK_ERROR_GET_NOTREADY
    DWC_RNK_ERROR_GET_INVALID_KEY
    DWC_RNK_ERROR_GET_NOMEMORY
    DWC_RNK_ERROR_CANCEL_NOTASK
    DWC_RNK_PROCESS_NOTASK
    DWC_RNK_PROCESS_TIMEOUT
    DWC_RNK_ERROR_INVALID_MODE
    DWC_RNK_ERROR_NOTCOMPLETED
    DWC_RNK_ERROR_EMPTY_RESPONSE
};
DWC_RNK_SUCCESS Succeeded.
DWC_RNK_IN_ERROR An error is being generated.
DWC_RNK_ERROR_INVALID_PARAMETER Invalid parameter.
DWC_RNK_ERROR_INIT_ALREADYINITIALIZED Initialized.
DWC_RNK_ERROR_INIT_INVALID_INITDATASIZE Invalid initial data size.
DWC_RNK_ERROR_INIT_INVALID_INITDATA Invalid initial data.
DWC_RNK_ERROR_INIT_INVALID_USERDATA Invalid user information.
DWC_RNK_ERROR_PUT_NOTREADY Not initialized.
DWC_RNK_ERROR_PUT_INVALID_KEY Invalid encryption key.
DWC_RNK_ERROR_PUT_NOMEMORY Insufficient memory.
DWC_RNK_ERROR_GET_NOTREADY Not initialized.
DWC_RNK_ERROR_GET_INVALID_KEY Invalid encryption key.
DWC_RNK_ERROR_GET_NOMEMORY Insufficient memory.
DWC_RNK_ERROR_CANCEL_NOTASK No processing during asynchronous processing.
DWC_RNK_PROCESS_NOTASK No processing during asynchronous processing.
DWC_RNK_PROCESS_TIMEOUT Timeout.
DWC_RNK_ERROR_INVALID_MODE Invalid mode.
DWC_RNK_ERROR_NOTCOMPLETED Communications not completed.
DWC_RNK_ERROR_EMPTY_RESPONSE Empty response.

Module Status

enum DWCRnkState {
    DWC_RNK_STATE_NOTREADY        0
    DWC_RNK_STATE_INITIALIZED
    DWC_RNK_STATE_PUT_ASYNC
    DWC_RNK_STATE_GET_ASYNC
    DWC_RNK_STATE_COMPLETED
    DWC_RNK_STATE_TIMEOUT
    DWC_RNK_STATE_ERROR
};
DWC_RNK_STATE_NOTREADY Uninitialized.
DWC_RNK_STATE_INITIALIZED Initialized.
DWC_RNK_STATE_PUT_ASYNC Currently executing asynchronous PUT process.
DWC_RNK_STATE_GET_ASYNC Currently executing asynchronous GET process.
DWC_RNK_STATE_COMPLETED Done.
DWC_RNK_STATE_TIMEOUT Timeout.
DWC_RNK_STATE_ERROR Error occurred.

Region Codes

enum DWCRnkRegion {
    DWC_RNK_REGION_JP      0x01
    DWC_RNK_REGION_US      0x02
    DWC_RNK_REGION_EU      0x04
    DWC_RNK_REGION_KR      0x08
    DWC_RNK_REGION_CH      0x10
    DWC_RNK_REGION_ALL     0xff
};
DWC_RNK_REGION_JP Japan
DWC_RNK_REGION_US North America
DWC_RNK_REGION_EU Europe
DWC_RNK_REGION_KR Korea
DWC_RNK_REGION_CH China
DWC_RNK_REGION_ALL World

Modes for Getting DWC_RnkGetScoreAsync

enum DWCRnkGetMode {
    DWC_RNK_GET_MODE_ORDER
    DWC_RNK_GET_MODE_TOPLIST
    DWC_RNK_GET_MODE_NEAR
    DWC_RNK_GET_MODE_FRIENDS
    DWC_RNK_GET_MODE_NEAR_HI
    DWC_RNK_GET_MODE_NEAR_LOW
};
DWC_RNK_GET_MODE_ORDER Order.
DWC_RNK_GET_MODE_TOPLIST High score.
DWC_RNK_GET_MODE_NEAR Nearby scores.
DWC_RNK_GET_MODE_FRIENDS Ranking with friends specified.
DWC_RNK_GET_MODE_NEAR_HI Nearby scores (higher than one's own ranking).
DWC_RNK_GET_MODE_NEAR_LOW Nearby scores (lower than one's own ranking).

Flag for Outputting DWC Debug Information

enum DWCReportFlag {
    DWC_REPORTFLAG_NONE                0x00000000
    DWC_REPORTFLAG_INFO                0x00000001
    DWC_REPORTFLAG_ERROR               0x00000002
    DWC_REPORTFLAG_DEBUG               0x00000004
    DWC_REPORTFLAG_WARNING             0x00000008
    DWC_REPORTFLAG_ACHECK              0x00000010
    DWC_REPORTFLAG_LOGIN               0x00000020
    DWC_REPORTFLAG_MATCH_NN            0x00000040
    DWC_REPORTFLAG_MATCH_GT2           0x00000080
    DWC_REPORTFLAG_TRANSPORT           0x00000100
    DWC_REPORTFLAG_QR2_REQ             0x00000200
    DWC_REPORTFLAG_SB_UPDATE           0x00000400
    DWC_REPORTFLAG_SEND_INFO           0x00008000
    DWC_REPORTFLAG_RECV_INFO           0x00010000
    DWC_REPORTFLAG_UPDATE_SV           0x00020000
    DWC_REPORTFLAG_CONNECTINET         0x00040000
    DWC_REPORTFLAG_AUTH                0x01000000
    DWC_REPORTFLAG_AC                  0x02000000
    DWC_REPORTFLAG_BM                  0x04000000
    DWC_REPORTFLAG_UTIL                0x08000000
    DWC_REPORTFLAG_OPTION_CF           0x10000000
    DWC_REPORTFLAG_OPTION_CONNTEST     0x20000000
    DWC_REPORTFLAG_GAMESPY             0x80000000
    DWC_REPORTFLAG_TEST                0x00100000
    DWC_REPORTFLAG_ALL                 0xffffffff
};
DWC_REPORTFLAG_NONE
DWC_REPORTFLAG_INFO
DWC_REPORTFLAG_ERROR
DWC_REPORTFLAG_DEBUG
DWC_REPORTFLAG_WARNING
DWC_REPORTFLAG_ACHECK
DWC_REPORTFLAG_LOGIN
DWC_REPORTFLAG_MATCH_NN
DWC_REPORTFLAG_MATCH_GT2
DWC_REPORTFLAG_TRANSPORT
DWC_REPORTFLAG_QR2_REQ
DWC_REPORTFLAG_SB_UPDATE
DWC_REPORTFLAG_SEND_INFO
DWC_REPORTFLAG_RECV_INFO
DWC_REPORTFLAG_UPDATE_SV
DWC_REPORTFLAG_CONNECTINET
DWC_REPORTFLAG_AUTH
DWC_REPORTFLAG_AC
DWC_REPORTFLAG_BM
DWC_REPORTFLAG_UTIL
DWC_REPORTFLAG_OPTION_CF
DWC_REPORTFLAG_OPTION_CONNTEST
DWC_REPORTFLAG_GAMESPY
DWC_REPORTFLAG_TEST
DWC_REPORTFLAG_ALL

Enumeration Type Indicating the SVC Acquisition State

enum DWCSvlState {
    DWC_SVL_STATE_DIRTY        0
    DWC_SVL_STATE_IDLE
    DWC_SVL_STATE_HTTP
    DWC_SVL_STATE_SUCCESS
    DWC_SVL_STATE_ERROR
    DWC_SVL_STATE_CANCELED
    DWC_SVL_STATE_MAX
};
DWC_SVL_STATE_DIRTY Uninitialized.
DWC_SVL_STATE_IDLE Not currently running.
DWC_SVL_STATE_HTTP Currently performing HTTP communications.
DWC_SVL_STATE_SUCCESS Token acquisition was successful.
DWC_SVL_STATE_ERROR Token acquisition failed.
DWC_SVL_STATE_CANCELED Token acquisition was canceled.
DWC_SVL_STATE_MAX

Type Definitions

typedef DWCAccUserData DWCUserData The player data for each player, including login ID.

Make sure that the members of this structure are not accessed directly.

typedef DWCAccFriendData DWCFriendData This union stores friend data.

Make sure that the members of this union are not accessed directly.

typedef struct tagDWCCfInfo DWCCfInfo This structure stores the data obtained by the DWC_CfGetWiiNumber function.



CONFIDENTIAL