RVL DWC Library (DWC) Function List

Common and Utilities

Initialization

DWC_Init Initializes the DWC library.
DWC_Shutdown Closes the DWC library.

Errors

DWC_GetLastError Gets the error information for the last communication error.
DWC_GetLastErrorEx Gets the error type, error code, and error process type of the last communication error.
DWC_ClearError Clears the record of communication errors.

Memory Allocation

DWCAllocEx Function for allocating memory used by the entire DWC library.
DWCFreeEx Function for deallocating memory used by the entire DWC library.
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_Free This utility frees 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.

Base 64 Conversion

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

String Operations

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

Debug Output

DWC_SetReportLevel Specifies the debug display level.
DWC_Printf DWC debug report function.

Constants, Macros, Enumerators

Click here.

Accounts

User Data

DWC_CreateUserData Creates user data.
DWC_CheckUserData Checks the validity of user data.
DWC_CheckHasProfile Checks whether the user data already has a valid profile (login ID).
DWC_CheckDirtyFlag Checks whether the dirty flag indicates that user data has been updated.
DWC_ClearDirtyFlag Clears the dirty flag that indicates that user data has been updated.
DWC_IsCompatibleUserData Confirms whether the user data is the same as the initial code (gamecode) specified by DWC_Init.
DWC_GetFriendKey Acquires the friend code from friend data.
DWC_CreateFriendKey Generates the friend code (from user data) to be exchanged with friends.
DWC_CreateFriendKeyLegacy Generates the friend code (from user data) to be exchanged with friends. (For compatibility with past versions.)
DWC_CreateExchangeToken Uses the user data to create friend data to be exchanged while not connected to the Wi-Fi Connection.
DWC_CreateFriendKeyToken Creates friend data (from the friend code) to be stored in the friend roster.
DWC_SetGsProfileId Stores the GS profile ID in friend data (for debugging).
DWC_CheckFriendKey Checks the validity of the friend code.
DWC_CheckFriendKeyLegacy Checks the validity of the friend code. (For compatibility with past versions.)
DWC_IsEqualFriendData Checks whether two sets of friend data are identical.
DWC_IsValidFriendData Checks whether valid data has been set in friend data.
DWC_IsBuddyFriendData Checks whether friend data already exists on the GameSpy server as a friend relationship.
DWC_GetFriendDataType Obtains the data type in which friend data was saved.
DWC_ClearBuddyFlagFriendData Clears the friend established flag for friend data.
DWC_GetGsProfileId Gets the GS profile ID from friend information.
DWC_ReportFriendData Displays friend data (for debugging).
DWC_ReportUserData Displays the user data (for debugging).

Authentication server

Login

DWC_GetIngamesnCheckResult Gets the result of the NAS ingamesn check.
DWC_NasLoginAsync Starts NAS login.
DWC_NasLoginProcess Continues the NAS login operation.
DWC_NasLoginAbort Aborts login to the Nintendo Authentication Server.

Server Time

DWC_GetDateTime Acquires the current date and time (in GMT), based on the time data obtained from the authentication server during authentication.

Structures

DWCDate Structure representing the date.
DWCTime Structure representing the time.

Constants, Macros, Enumerators

Click here.

Friend Management and Matchmaking

General

DWCLoginCallback Login complete callback.
DWCConnectionClosedCallback Connection closed callback.
DWC_InitFriendsMatch Initializes the DWC FriendsMatch library.
DWC_ShutdownFriendsMatch Terminates the DWC FriendsMatch library and frees the heap region allocated by the library.
DWC_ProcessFriendsMatch Updates the communications process.
DWC_LoginAsync Connects to Nintendo Wi-Fi Connection.
DWC_UpdateServersAsync Synchronizes the local friend roster with the friend roster on the GameSpy server.
DWC_ConnectToAnybodyAsync This function starts pair matchmaking without specifying friends.
DWC_ConnectToFriendsAsync This function starts pair matchmaking with friends specified.
DWC_SetupGameServer This function starts the server host performing server-client matchmaking.
DWC_ConnectToGameServerAsync This function starts client host connections made during server-client matchmaking.
DWC_ConnectToGameServerByGroupID Tries to reconnect to a group by specifying the group ID.
DWC_SetConnectionClosedCallback Sets the callback function to be called each time a connection is disconnected.
DWC_CloseAllConnectionsHard This function disconnects connections.
DWC_CloseConnectionHard This function terminates the connection with the host with the specified AID.
DWC_CloseConnectionHardBitmap This function terminates the connections with the hosts specified by an AID bitmap.
DWC_GetNumConnectionHost Gets the number of connection hosts.
DWC_GetMyAID Gets the one's own AID.
DWC_GetAIDList This function gets the AID list of connected hosts.
DWC_GetAIDBitmap This function gets the AID bitmap of connected hosts.
DWC_IsValidAID This function checks whether the specified AID is currently connected.
DWC_GetState Gets the internal status of the DWC FriendsMatch library (for debugging).
DWC_GetServerAID This function gets the AID of the server host managing acceptance into the group.
DWC_IsServerMyself Gets whether the local host is the server host that accepts new participants.
DWC_GetDirectConnectedAIDBitmap Gets the AID bitmap of other hosts with whom the local host has a direct connection.

Friend Roster

DWCUpdateServersCallback Friend roster synchronization process callback.
DWCFriendStatusCallback Friend status change notification callback.
DWCDeleteFriendListCallback Friend roster deletion callback.
DWCBuddyFriendCallback Callback for a friend established through another friend.
DWC_GetFriendStatus Obtains a friend's status. (String version.)
DWC_GetFriendStatusSC Obtains a friend's status. (This version gets a 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_GetNumFriend Obtains the number of registered friends in the friend roster.
DWC_SetOwnStatusString Registers the user's own status on the GameSpy server. (String version.)
DWC_GetOwnStatusString Obtains the user's own status. (String version.)
DWC_SetOwnStatusData Registers the user's own status on the GameSpy server. (Binary version.)
DWC_GetOwnStatusData Obtains the user's own status. (Binary version.)
DWC_CanChangeFriendList Checks whether the friend roster can be changed.
DWC_DeleteBuddyFriendData Deletes a friend from the friend roster, and deletes the friend relationship from the GameSpy server.
DWC_SetBuddyFriendCallback Sets the callback to be called when a friend relationship is established.
DWC_SetFriendStatusCallback This function configures the callback called when a friend's communication status changes.

Data Storage-Related Items

DWCStorageLoginCallback Type for data storage server login callbacks.
DWCSaveToServerCallback Type for data storage server save completion callbacks.
DWCLoadFromServerCallback Type for data storage server load completion callbacks.
DWC_LoginToStorageServerAsync This function logs in to the data storage server.
DWC_LogoutFromStorageServer This function logs off the data storage server.
DWC_SetStorageServerCallback Registers the data storage server save completion and load completion notification callbacks.
DWC_SavePublicDataAsync Saves Public data to the data storage server.
DWC_SavePrivateDataAsync Saves Private data to the data storage server.
DWC_LoadOwnPublicDataAsync Loads the player's Public data from the data storage server.
DWC_LoadOwnPrivateDataAsync Loads the player's Private data from the data storage server.
DWC_LoadOthersDataAsync Loads another player's data from the data-storage server.

Matchmaking

DWCMatchedSCCallback Type for matchmaking completion callbacks.
DWCNewClientCallback Type for new client connection start notification callbacks.
DWCEvalPlayerCallback Type for player evaluation callbacks.
DWCConnectAttemptCallback Type for matchmaking condition determination callbacks.
DWCSuspendCallback Type for suspend completion callbacks.
DWC_RegisterMatchStatus This function registers host information used for matchmaking, registering the local host's information first.
DWC_CancelMatch This function cancels the matchmaking process.
DWC_IsValidCancelMatch This function checks whether the matchmaking process can be canceled.
DWC_AddMatchKeyInt This function adds a matchmaking condition key (int version).
DWC_AddMatchKeyString This function adds a matchmaking condition key (string version).
DWC_GetMatchIntValue This function gets the matchmaking condition key (int version).
DWC_GetMatchStringValue This function gets the matchmaking condition key (string version).
DWC_GetLastMatchType This function gets the last type of matchmaking performed.
DWC_GetMatchState This function gets the internal state during matchmaking. (For debugging.)
DWC_GetGroupID This function gets the ID of the group to which the local host currently belongs.
DWC_RequestSuspendMatchAsync Starts the processing to change the acceptance status of new participants during matchmaking.
DWC_GetSuspendMatch Obtains whether new hosts are currently being accepted.
DWC_GetConnectionUserData Gets the ConnUserData for the host having the specified AID.
DWC_SetDebugMeshNNRetryMax This function sets the maximum number of retries allowed when NAT traversal fails while creating a mesh network. (For debugging.)
DWC_GetDebugMeshNNRetryMax This function gets the maximum number of retries allowed when NAT traversal fails while creating a mesh network. (For debugging.)

Sending and Receiving

DWCUserSendCallback This function is called when transmission of data sent by the DWC_SendReliable/DWC_SendReliableBitmap or DWC_SendUnreliable/DWC_SendUnreliableBitmap functions is complete.
DWCUserRecvCallback This function is called when data sent by the DWC_SendReliable/DWC_SendReliableBitmap or DWC_SendUnreliable/DWC_SendUnreliableBitmap functions has been received.
DWCUserRecvTimeoutCallback This function is called when data from a host has not been received for the time period specified by the DWC_SetRecvTimeoutTime function.
DWCUserPingCallback This callback function notifies the user of the measurement results from the DWC_Ping function.
DWC_SendReliable This function performs reliable transmissions, using UDP to the specified AID 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 AID 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_Ping This function measures the communication latency of the specified AID during connection.
DWC_SetRecvBuffer This function configures the Receive buffer.
DWC_SetUserSendCallback Configures the Send callback.
DWC_SetUserRecvCallback Configures the Receive callback.
DWC_SetUserRecvTimeoutCallback This function sets the callback function for notifying of 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_SetUserPingCallback This function sets the callback function for getting the result of the latency measurement.
DWC_SetSendSplitMax This function sets the split send size to use with reliable transmissions.
DWC_IsSendableReliable This function checks whether reliable transmission to the specified AID is possible.
DWC_SetConnectionKeepAliveTime Sets the timeout, which is the standard for determining when to disconnect from a connected peer after a fixed period of time elapses with no reliable or unreliable transfer from that peer.
DWC_GetConnectionKeepAliveTime Gets the timeout, which is the standard for determining when to disconnect from a connected peer after a fixed period of time elapses with no reliable or unreliable transfer from that peer.
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_SetSendDrop Sets the packet loss rate when sending. (For debugging.)
DWC_SetRecvDrop Sets the packet loss rate when receiving. (For debugging.)

Constants, Macros, Enumerators

Refer here.

LAN Matching

General

DWCLanMatchedCallback This callback function is called when LAN matching is complete.
DWCRecvLanMatchCallback This callback function is called when data has been received during LAN matching communications.
DWCSendLanMatchCallback This callback function is called when data has been sent during LAN matching communications.
DWC_InitLanMatch Initializes variables for controlling the LAN matching library.
DWC_SetRecvLanMatchCallback Sets the receive callback to use during LAN matching communications.
DWC_SetSendLanMatchCallback Sets the send callback to use during LAN matching communications.
DWC_ProcessLanMatch This function performs LAN matching communication processing.
DWC_SendLanMatch Sends data to the specified AID after matching is complete.
DWC_StartLanMatch Constructs a mesh network.
DWC_ShutdownLanMatch Performs shutdown processing, including deallocation of memory allocated by the library.
DWC_GetMyAIDLanMatch Obtains the user's own AID.
DWC_GetConnectNumLanMatch Gets the number of connected hosts (including the local host).

Constants, Macros, Enumerators

Refer here.

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 registering scores.
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_RnkResGetRow Gets the specified index row in the ranking list from the communications result.
DWC_RnkResGetRowCount Gets the number of rows 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

DWCRnkData Structure for storing score data.
DWCRnkGetParam_order Parameter specified in get-rank mode.
DWCRnkGetParam_toplist Parameter specified in get-top ranking list mode.
DWCRnkGetParam_nearby Parameter specified in get-top ranking list mode.
DWCRnkGetParam_friends Parameter specified in get-friend ranking list mode.
DWCRnkGetParam Parameter specified by DWC_RnkGetScoreAsync.

Constants, Macros, Enumerators

Refer here.

Download

General

DWCNdCallback This is the type for notification callback functions that are called by the Download library.
DWC_NdInitAsync Starts the process of Download library initialization.
DWC_NdProcess Advances the Download library process.
DWC_NdCleanupAsync Starts the process of closing the Download library.
DWC_NdSetAttr Sets the attribute strings for the Download library.
DWC_NdGetFileListNumAsync Starts getting the total number of files that can currently be downloaded.
DWC_NdGetFileListAsync Starts getting the list of files that can currently be downloaded.
DWC_NdGetFileAsync Starts file downloading.
DWC_NdCancelAsync Cancels the HTTP process that the Download library is currently running.
DWC_NdGetProgress Gets the progress status of the file download that is currently running.

Structures

DWCNdFileInfo This structure stores the file information that the Download library receives.

Constants, Macros, Enumerators

Click here.

Console Friend Link Feature

General

DWC_CfSetAppFriendKeyToNWC24Msg Appends information for game friend exchanges to an NWC24MsgObj.
DWC_CfGetAppFriendKeyFromNWC24Msg Extracts information for game friend exchanges from an NWC24 message.
DWC_CfReset Releases the memory secured by DWC_CfSetAppFriendKeyToNWC24Msg.
DWC_CfGetConsoleInfo Gets a friend's console information from the friend data.

Structures

DWCCfInfo This structure stores the data obtained by the DWC_CfGetWiiNumber function.

Constants, Macros, Enumerators

Refer here.

Connection Test

General

DWC_TestInternetConnection Performs an Internet connection test by communicating with the connection test server.

Constants, Macros, Enumerators

Refer here.

Illegal String Check

General

DWC_CheckProfanityAsync Starts the check for illegal strings.
DWC_CheckProfanityExAsync Starts a check for illegal strings. (This version specifies the region.)
DWC_CheckProfanityProcess Proceeds with the illegal string check process.

Constants, Macros, Enumerators

Click here.

CONFIDENTIAL