[DWC] DS Wi-Fi Connection Library Function List

Account Processes

Initialization

DWC_Init Initializes the DWC library.
DWC_SetMemFunc This function allocates/deallocates memory for communication.
DWC_SetReportLevel Specifies the debug display level. (for debugging)
DWC_Debug_DWCInitError This function is for DWC_Init function error checking. (for debugging)

User Data

DWC_CreateUserData Creates user data.
DWC_ReportUserData Displays the user data. (for debugging)
DWC_CheckUserData Checks the validity of the user data.
DWC_CheckValidConsole Checks if the DS system is handled with the user data as a set.
DWC_CheckHasProfile Checks if the user data already has a valid profile (login ID).
DWC_CheckDirtyFlag Checks to see if the dirty flag indicates that the user data has been updated.
DWC_ClearDirtyFlag Clears the dirty flag that indicates the user data has been updated.

Friend Data

DWC_CreateFriendKey Generates a friend registration key from the user data that will be exchanged with friends.
DWC_CreateExchangeToken Uses the user data to creates friend data to be exchanged through DS wireless communication.
DWC_CreateFriendKeyToken Uses the friend registration key to create the friend data to be stored in the friend roster.
DWC_GetFriendKey Uses the friend data to obtain the friend registration key.
DWC_CheckFriendKey Checks the validity of the friend registration key.
DWC_IsEqualFriendData Checks if two sets of friend data are identical.
DWC_IsValidFriendData Checks if valid data has been set in the friend data.
DWC_IsBuddyFriendData Checks if the friend data already exists in the GameSpy server as a friend relationship.
DWC_GetFriendDataType Obtains the data type in which the friend data was saved.
DWC_GetGsProfileId Gets the profile ID from the friend information.
DWC_ClearBuddyFlagFriendData Clears the friend established flag for the friend data.
DWC_ReportFriendData Displays friend data. (for debugging)
DWC_SetGsProfileId Stores the GS profile ID in the friend data. (for debugging)

Internet Connection Processes

Internet Connections

DWC_InitInet Initializes the automatic connection control object.
DWC_InitInetEx Initializes the automatic connection control object.
DWC_SetAuthServer Sets the authentication server.
DWC_SetConnectApType This function sets the type of AP for connections in the auto-connect process. (for debugging)
DWC_ConnectInetAsync Initializes the automatic connection process.
DWC_DebugConnectInetAsync Initializes the automatic connection process. Connects using the AP specified in the argument. (for debugging)
DWC_CheckInet Checks the connection status.
DWC_UpdateConnection Checks the connection to an access point.
DWC_ProcessInet Updates the status.
DWC_GetInetStatus Checks the connection status.
DWC_CleanupInet This function ends automatic connection control (synchronous version).
DWC_CleanupInetAsync This function ends automatic connection control (asynchronous version).
DWC_GetLinkLevel This function gets the wireless signal strength between the local DS and the access point.
DWC_GetApInfo This function gets information specific to the connected access point.

Nintendo Wi-Fi Connection Setup

DWC_StartUtility Starts the Nintendo Wi-Fi Connection setup.
DWC_StartUtilityEx Starts the Nintendo Wi-Fi Connection setup.

Structures and Constants

DWCApInfo This structure stores information specific to the connected access point.

Nintendo Wi-Fi Connection Connect Process

General

DWC_NASLoginAsync Performs authentication with the Nintendo Authentication Server and connects to Wi-Fi connection.
DWC_NASLoginProcess Proceeds with the authentication process and gets its state.
DWC_NASLoginAbort Aborts the authentication process.

Structures and Constants

DWCNasLoginState This enumerated type indicates the state of the authentication process.

Friend Management and Matchmaking Processes

General

DWC_InitFriendsMatch Initializes the DWC FriendsMatch library.
DWC_ShutdownFriendsMatch Terminates the DWC FriendsMatch library and frees the heap region allocated inside the library.
DWC_ProcessFriendsMatch Updates the communications process.
DWC_LoginAsync Connects to Nintendo Wi-Fi Connection.
DWC_GetState Gets the internal status of the DWC FriendsMatch library. (for debugging)
DWC_GetIngamesnCheckResult Gets the check result for the in-game screen name from the authentication server.
DWC_GetDateTime Gets the current and date in GMT.

Friend Roster

DWC_UpdateServersAsync Synchronizes the local friend roster with the friend roster on the GameSpy server.
DWC_DeleteBuddyFriendData Deletes a friend from the friend roster and also deletes the friend relationship from the GameSpy server.
DWC_GetNumFriend Obtains the number of registered friends in the friend roster.
DWC_CanChangeFriendList Checks whether or not the friend roster can be changed.
DWC_SetFriendStatusCallback This function configures the callback called when a friend's networking state changes.
DWC_SetBuddyFriendCallback Sets the callback to be called when a friend relationship has been established.
DWC_GetFriendStatus Obtains a friend's status. (character string version)
DWC_GetFriendStatusSC Obtains a friend's status. (This version gets a character string and the number of connections during server-client matchmaking.)
DWC_GetFriendStatusData Obtains a friend's status. (binary version)
DWC_GetFriendStatusDataSC Obtains a friend's status. (This version gets a binary and the number of connections during server-client matchmaking.)
DWC_SetOwnStatusString Registers own status with the GameSpy server. (character string version)
DWC_GetOwnStatusString Obtains own status. (character string version)
DWC_SetOwnStatusData Registers own status with the GameSpy server. (binary version)
DWC_GetOwnStatusData Obtains own status. (binary version)

Matchmaking

DWC_ConnectToAnybodyAsync This function starts pair matchmaking without specifying a friend.
DWC_ConnectToFriendsAsync This function starts pair matchmaking by specifying a friend.
DWC_SetupGameServer This function starts the server DS for server-client matchmaking.
DWC_SetupGameServerAsync This function starts the server DS for server-client matchmaking.
DWC_ConnectToGameServerAsync This function starts client DS connections made during server-client matchmaking.
DWC_GetNumConnectionHost Gets the number of connection hosts.
DWC_GetMyAID Gets the DS's own AID.
DWC_GetAIDList This function gets the AID list from a connected host.
DWC_GetAIDBitmap This function gets the AID bitmap from a connected host.
DWC_IsValidAID This function checks whether the specified AID is currently connected.
DWC_CloseAllConnectionsHard This function disconnects connections.
DWC_CloseConnectionHard This function terminates the connection with the host having the specified AID.
DWC_CloseConnectionHardBitmap This function terminates the connection with the host having the specified AID bitmap.
DWC_CloseConnectionsAsync This function disconnects connections.
DWC_SetConnectionClosedCallback Sets the callback function to be called each time a connection is disconnected.
DWC_RegisterMatchingStatus This function registers self-host information used for matchmaking, in advance.
DWC_CancelMatching This function cancels the matchmaking process.
DWC_CancelMatchingAsync This function cancels the matchmaking process.
DWC_IsValidCancelMatching This function checks whether the matchmaking process can be cancelled.
DWC_StopSCMatchingAsync This function cancels server-client matchmaking currently in process.
DWC_AddMatchKey* Function for adding a matchmaking index key
DWC_GetMatch*Value Function for getting the matchmaking index key
DWC_GetLastMatchingType This function gets the last type of matchmaking performed.
DWC_GetMatchingState This function gets the internal state during matchmaking. (for debugging)

Matchmaking Options

DWC_SetMatchingOption Sets matchmaking options.
DWC_GetMatchingOption Gets matchmaking option settings.
DWC_GetMOMinCompState This function gets the status of the option to complete matchmaking with fewer than the specified number of players.
DWC_GetMOSCConnectBlockState Gets the status of the matchmaking block option.
DWC_ClearMOSCConnectBlock Releases the block status caused by the matchmaking block option.

Errors

DWC_GetLastError Gets the type of the last communication error.
DWC_GetLastErrorEx Gets the type of the last communication error. The extended version that can obtain the recovery type for the library.
DWC_ClearError Clears the record of communication errors.

Data Storage Server-Related

DWC_LoginToStorageServerAsync This function logs in to the data storage server.
DWC_LogoutFromStorageServer This function logs out from the data storage server.
DWC_SavePublicDataAsync Saves Public data to the data storage server.
DWC_SavePrivateDataAsync Saves Private data to the data storage server.
DWC_LoadOwnDataAsync Loads one's own data from the data storage server.
DWC_LoadOwnPublicDataAsync Loads one's own Public data from the data storage server.
DWC_LoadOwnPrivateDataAsync Loads one's own Private data from the data storage server.
DWC_LoadOthersDataAsync Loads another player's data from data storage server.
DWC_SetStorageServerCallback Registers the callbacks to call when the data has been saved to/loaded from the data storage server.

Sending & Receiving

DWC_SetRecvBuffer This function configures the Receive buffer.
DWC_SendReliable This function performs reliable transmissions using UDP to the specified AIDs after connection is established.
DWC_SendReliableBitmap This function performs reliable transmissions to a specified bitmap using UDP after a connection is established.
DWC_SendUnreliable This function performs unreliable transmissions to the specified AIDs using UDP after connection is established.
DWC_SendUnreliableBitmap This function performs unreliable transmissions to a specified bitmap using UDP after a connection is established.
DWC_SetUserSendCallback Configures the Send callback.
DWC_SetUserRecvCallback Configures the Receive callback.
DWC_SetSendDrop Sets the packet loss rate when sending. (for debugging)
DWC_SetRecvDrop Sets the packet loss rate when receiving. (for debugging)
DWC_SetSendDelay Sets the time delay (in ms) when sending. (for debugging)
DWC_SetRecvDelay Sets the time delay (in ms) when receiving. (for debugging)
DWC_Ping This function measures the communication latency of the specified AID during connection.
DWC_SetUserPingCallback This function sets the callback function for getting the result of the latency measurement.
DWC_IsSendableReliable This function checks whether or not reliable transmission to the specified AID is possible.
DWC_SetSendSplitMax This function sets the split send size to use with reliable transmissions.
DWC_SetUserRecvTimeoutCallback This function sets the callback function for notifying receive timeouts when data has not been received for a set period of time.
DWC_SetRecvTimeoutTime This function sets the timeout for the receive timeout.
DWC_GetUdpPacketDropNum Gets the number of UDP packets that could not be received due to overflow of the receive buffer.

Callback Functions

DWCBuddyFriendCallback This callback function is called when a friend relationship has been established.
DWCConnectionClosedCallback This callback function is called each time a connection is disconnected.
DWCDeleteFriendListCallback This callback function is called when friend data has been automatically deleted from the friend roster after DWC_UpdateServersAsync has been called.
DWCEvalPlayerCallback This callback function is called to select a connection partner during matchmaking.
DWCFriendStatusCallback This callback function is called each time friend status is updated.
DWCLoadFromServerCallback This callback function is called when reading from the data storage server completes.
DWCLoginCallback This callback function is called when login is completed.
DWCMatchedCallback This callback function is called when matchmaking is complete.
DWCMatchedSCCallback This callback function is called when server-client matchmaking is complete.
DWCNewClientCallback This callback function is called when a client DS starts a connection under server-client matchmaking.
DWCSaveToServerCallback This callback function is called when writing to the data storage server is complete.
DWCStorageLoginCallback This callback function is called when there is a login to the data storage server.
DWCStopSCCallback This callback function is called when the client-server matchmaking in process is canceled.
DWCUpdateServersCallback This callback function is called when updating of the friend roster is complete.
DWCUserPingCallback This callback function is called when notifying the time required to measure the communication latency of the partner.
DWCUserRecvCallback This callback function is called when data has been received.
DWCUserRecvTimeoutCallback This callback function is called when data has not been received within a set period of time.
DWCUserSendCallback This callback function is called when sending of data is completed.

Structures and Constants

DWCUserData The structure for storing one's own data.
DWCFriendData This union stores friend data.
DWCMatchOptMinComplete This structure is used to set the option to complete matchmaking with less than the specified number of players.
DWC Library Constants An explanation of the constants in the DWC library.

HTTP Communications

General

DWC_InitGHTTP This function initializes the GHTTP library.
DWC_ProcessGHTTP This function updates HTTP communication processing.
DWC_ShutdownGHTTP This function shuts down the GHTTP library.
DWC_GHTTPNewPost This function creates an object to be uploaded.
DWC_GHTTPPostAddString This function adds data to an object to be uploaded.
DWC_GetGHTTPData This function downloads data.
DWC_GetGHTTPDataEx This function downloads data.
DWC_GetGHTTPState This function checks the HTTP connection status.
DWC_CancelGHTTPRequest This function cancels HTTP communication.
DWC_PostGHTTPData This function uploads data.

Callback Functions

DWCGHTTPProgressCallback This callback function is called during HTTP processing.
DWCGHTTPCompletedCallback This callback function is called when HTTP processing is completed.

Structures and Constants

HTTP Communication Constants This is a description of the constants used under DWC_GHTTP.

General-Purpose Ranking

General

DWC_RnkInitialize Initializes the Ranking library.
DWC_RnkShutdown Performs the Ranking library end process.
DWC_RnkPutScoreAsync Starts the asynchronous process for recording the score.
DWC_RnkGetScoreAsync Starts the asynchronous process for getting the ranking data.
DWC_RnkCancelProcess Cancels asynchronous processing.
DWC_RnkProcess Updates the asynchronous process.
DWC_RnkGetState Gets the current processing state.
DWC_RnkResGetRowCount Gets the number of rows in the ranking list from the communications result.
DWC_RnkResGetRow Gets the specified index row in the ranking list from the communications result.
DWC_RnkResGetOrder Gets the rank order from the communications result.
DWC_RnkResGetTotal Gets the communications result rank-order parameter total.

Structures and Constants

General-purpose ranking constant Description of constants used with general-purpose ranking.
DWCRnkError The enumeration type expressing the error codes for the general-purpose ranking process.
DWCRnkState The enumeration type expressing the state of the general-purpose ranking process.
DWCRnkRegion The enumeration type expressing the region code.
DWCRnkGetMode The enumeration type expressing the modes specified by the DWC_RnkGetScoreAsync function.
DWCRnkData The structure that stores ranking information.
DWCRnkGetParam The structure that gets specified as the parameter of the DWC_RnkGetScoreAsync function.

Download

General

DWC_NdInitAsync Starts the process that initializes the Download library.
DWC_NdCleanupAsync Starts the process that ends the Download library.
DWC_NdSetAttr Configures the attribute information necessary for communications with the Download server.
DWC_NdGetFileListNumAsync Gets the number of downloadable files that comply with the currently configured attribute.
DWC_NdGetFileListAsync Gets the list of files that comply with the currently configured attribute.
DWC_NdGetFileAsync Specifies the file information obtained by the DWC_NdGetFileListAsync function and starts downloading.
DWC_NdCancelAsync Cancels the currently executing asynchronous process.
DWC_NdGetProgress Gets the state of progress of the download that is currently executing.

Callback Functions

DWCNdCallback This callback function is called after the various asynchronous processes of the Download Library have completed.
DWCNdCleanpupCallback This callback function is called after the asynchronous end process of the Download Library has completed.

Structures and Constants

DWCNdError Enumeration type representing the type of error generated by the Download library.
DWCNdCallbackReason Enumeration type representing the reasons why the callback function is called by the Download library.
DWCNdFileInfo The structure that stores individual file information.

Utilities

Memory Allocation

DWC_Alloc This utility allocates memory using the function set by the application.
DWC_AllocEx This utility allocates memory using the function set by the application.
DWC_Realloc This utility reallocates memory using the function set by the application.
DWC_ReallocEx This utility reallocates memory using the function set by the application.
DWC_Free This utility frees memory using the function set by the application.

Character String Operations

DWC_SetCommonKeyValueString This function creates key/value character strings.
DWC_AddCommonKeyValueString This function adds key/value character strings.
DWC_GetCommonValueString Uses the key/value string to get the value string corresponding to the key string.

Base 64 Conversion

DWC_Base64Encode Encodes the designated data to char-type character string with Base64.
DWC_Base64Decode Decodes the designated Base64 data.

Terms

FriendsMatch Library

FriendsMatch Library The definitions of terms used in the FriendsMatch Library.

NTR-06-0404-001-C2
CONFIDENTIAL