TWL DWC Library (DWC) Function List

Common / Utilities

Initialization

DWC_InitForDevelopment Initializes the DWC library. (For development servers)
DWC_InitForProduction Initializes the DWC library. (For production servers)
DWC_Debug_DWCInitError Function to check errors in the DWC_InitForDevelopment and DWC_InitForProduction functions. (For debugging.)

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.

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 Allocates memory, using the function set by the application.
DWC_AllocEx Allocates memory, using the function set by the application.
DWC_Free Frees memory, using the function set by the application.
DWC_Realloc Reallocates memory, using the function set by the application.
DWC_ReallocEx Reallocates memory, using the function set by the application.

Base 64 Conversion

DWC_Base64Encode Encodes the specified data as Base64 data.
DWC_Base64Decode Decodes the specified Base64 character string.

String Operations

DWC_SetCommonKeyValueString Creates key/value strings.
DWC_AddCommonKeyValueString 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

Constants, Macros, Enumerators

See here.

Accounts

User Data

DWC_CreateUserData Creates user data.
DWC_CheckUserData Checks the validity of user data.
DWC_CheckValidConsole Checks if the Nintendo DS system is handled with the user data as a set.
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_CreateFriendKey Generates a friend registration key from user data so that the friend registration key can be passed to other hosts.
DWC_CreateFriendKeyLegacy Generates a friend registration key from user data so that the friend registration key can be passed to other hosts. (Old specification.)
DWC_CreateExchangeToken Uses the user data to create friend data to be exchanged through DS wireless communication.
DWC_CreateFriendKeyToken Creates the friend data from the friend registration key that is stored in the friend roster.
DWC_GetFriendKey Gets the friend registration key by using friend data.
DWC_CheckFriendKey Checks the validity of the friend registration key.
DWC_CheckFriendKeyLegacy Checks the validity of the friend registration key. (Old specification.)
DWC_FriendKeyToString Converts a friend registration key into a twelve-digit decimal string.
DWC_StringToFriendKey Converts a twelve-digit decimal string into a friend registration key.
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_WasBuddyFriendData Checks whether the friend specified in the argument has cancelled the friend relationship with the local host.
DWC_ClearBuddyFlagFriendData Clears the friend established flag for friend data.
DWC_GetFriendDataType Gets the data type in which friend data was saved.
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.)
DWC_SetGsProfileId Stores the GS profile ID in friend data (For debugging.)

System Information

DWC_GetAuthenticatedUserId Gets the authenticated user ID stored in the Nintendo DS.

Internet Connections

Internet Connections

DWC_InitInet Initializes the automatic connection control object.
DWC_InitInetEx Initializes the automatic connection control object. (Detailed specification version)
DWC_SetRwinSize Sets the rwin size used by TCP.
DWC_SetConnectApType Explicitly specifies the type of AP for connections in the auto-connect process (For debugging.)
DWC_ConnectInetAsync Starts the automatic connection process.
DWC_DebugConnectInetAsync Starts the automatic connection process.
Specifies a particular AP without using Nintendo DS settings (For debugging.)
DWC_CheckInet Checks the progress status of the automatic connection process.
DWC_ProcessInet Carries out automatic connection processing.
DWC_GetInetStatus Gets the Internet connection status.
DWC_UpdateConnection Checks the connection to an access point.
DWC_GetApInfo Gets information specific to the connected access point.
DWC_GetProxySetting Gets proxy setting information for the connected access point.
DWC_GetLinkLevel Gets the wireless signal strength between the local DS and the access point.
DWC_CleanupInet Ends automatic connection control (synchronous version).
DWC_CleanupInetAsync Ends automatic connection control (asynchronous version).
DWC_TestInetAsync Starts the Internet connection test.
DWC_TestInetProcess Executes the Internet connection test communication process.

Nintendo Wi-Fi Connection Setup

DWC_StartUtility Starts the Nintendo Wi-Fi Connection setup.
DWC_StartUtilityEx Starts the Nintendo Wi-Fi Connection setup. (version with no work memory specified)

Structures

DWCApInfo This structure stores information specific to the connected access point.
DWCProxySetting Gets proxy setting information for the connected access point.

Constants, Macros, Enumerators

See here.

Authentication Server

Login

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

Server Time

DWC_GetDateTime Gets the current date and time in GMT.

Service Locator

DWC_SVLGetTokenAsync Starts the process for getting service locator information.
DWC_SVLProcess Advances the process for getting service locator information.
DWC_SVLAbort Aborts the process for getting service locator information.

Structures

DWCSvlResult Structure for storing obtained service locator information.

Constants, Macros, Enumerators

See here.

Friend Management and Matchmaking

General

DWCLoginCallback Login completion callback type.
DWCConnectionClosedCallback Connection closed callback type.
DWC_InitFriendsMatch Initializes the DWCFriendsMatch library.
DWC_ShutdownFriendsMatch Terminates the DWCFriendsMatch library and frees the heap region allocated internally in 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 Starts pair matchmaking without specifying a friend.
DWC_ConnectToFriendsAsync Starts pair matchmaking by specifying a friend.
DWC_SetupGameServer Starts the server host performing server-client matchmaking.
DWC_ConnectToGameServerAsync 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_CloseConnectionHardFromServer Terminates the connection with the host with the specified AID.
DWC_CloseConnectionHardBitmapFromServer Terminates the connections with the hosts specified by an AID bitmap.
DWC_CloseAllConnectionsHard Closes connections or cancels a connection process currently being executed.
DWC_GetNumConnectionHost Gets the number of connection hosts.
DWC_GetMyAID Gets the local host's own AID.
DWC_GetAIDList Gets the AID list from a connected host.
DWC_GetAIDBitmap Gets the AID bitmap from a connected host.
DWC_IsValidAID Checks whether the specified AID is currently connected.
DWC_GetState Gets the internal status of the DWCFriendsMatch library (For debugging.)
DWC_GetServerAID 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.
DWC_GetIngamesnCheckResult Gets the check result for the in-game screen name from the authentication server.

Friend Roster

DWCUpdateServersCallback Friend roster synchronization callback type.
DWCFriendStatusCallback Friend status change notification callback type.
DWCDeleteFriendListCallback Friend roster deletion callback type.
DWCBuddyFriendCallback Type for friend relationship established callbacks.
DWC_GetFriendStatus Gets a friend's status. (String version.)
DWC_GetFriendStatusSC Gets a friend's status. (This version gets a character string and the number of connections during server-client matchmaking.)
DWC_GetFriendStatusData Gets a friend's status. (Binary version.)
DWC_GetFriendStatusDataSC Gets a friend's status. (This version gets a binary and the number of connections during server-client matchmaking.)
DWC_GetNumFriend Gets the number of registered friends in the friend roster.
DWC_SetOwnStatusString Registers the local host's own status on the GameSpy server. (String version.)
DWC_GetOwnStatusString Gets the local host's own status. (String version.)
DWC_SetOwnStatusData Registers the local host's own status on the GameSpy server. (Binary version.)
DWC_GetOwnStatusData Gets the local host'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 Configures the callback called when a friend's networking state changes.

Data Storage

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 Logs on to the data storage server.
DWC_LogoutFromStorageServer 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 local host's Public data from the data storage server.
DWC_LoadOwnPrivateDataAsync Loads the local host'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 Registers host information used for matchmaking, in advance.
DWC_CancelMatch Cancels the matchmaking process. (Deprecated.)
DWC_IsValidCancelMatch Checks whether the matchmaking process can be canceled. (Deprecated.)
DWC_AddMatchKeyInt Adds a matchmaking condition key (int version).
DWC_AddMatchKeyString Adds a matchmaking condition key (string version).
DWC_GetMatchIntValue Gets the matchmaking condition key (int version).
DWC_GetMatchStringValue Gets the matchmaking condition key (string version).
DWC_GetLastMatchType Gets the last type of matchmaking performed.
DWC_GetMatchState Gets the internal state during matchmaking (For debugging.)
DWC_GetGroupID 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 Gets information indicating whether new hosts are currently being accepted.
DWC_GetConnectionUserData Gets the connectionUserData for the host having the specified AID.
DWC_SetDebugMeshNNRetryMax Sets the maximum number of retries allowed when NAT traversal fails while creating a mesh network (For debugging.)
DWC_GetDebugMeshNNRetryMax Gets the maximum number of retries allowed when NAT traversal fails while creating a mesh network (For debugging.)

Sending and Receiving

DWC_GetUdpPacketDropNum Gets the number of UDP packets that could not be received due to overflow of the receive buffer.
DWCUserSendCallback Called when sending of data is completed.
DWCUserRecvCallback Called when data has been received.
DWCUserRecvTimeoutCallback Called when data has not been received in a set period of time.
DWCUserPingCallback This callback function sends notification of the measurement results from the DWC_Ping function.
DWC_SendReliable Performs reliable transfer, using UDP to the specified AIDs after connection is established.
DWC_SendReliableBitmap Performs reliable transfer to a specified bitmap, using UDP after a connection is established.
DWC_SendUnreliable Performs unreliable transfer to the specified AIDs using UDP after connection is established.
DWC_SendUnreliableBitmap Performs unreliable transfer to a specified bitmap using UDP after a connection is established.
DWC_Ping Measures the communication latency of the specified AID during connection.
DWC_SetRecvBuffer Configures the Receive buffer.
DWC_SetUserSendCallback Configures the Send callback.
DWC_SetUserRecvCallback Configures the Receive callback.
DWC_SetUserRecvTimeoutCallback Sets the callback function for notifying receive timeouts when data has not been received for a set period of time.
DWC_SetRecvTimeoutTime Sets the timeout for the receive timeout.
DWC_SetUserPingCallback Sets the callback function for getting the result of the latency measurement.
DWC_SetSendSplitMax Sets the split send size to use with reliable transfer.
DWC_IsSendableReliable Checks whether reliable transfer 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 transmission 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 transmission from that peer.
DWC_SetSendDelay Sets the time delay (in ms) when sending (For debugging.)
DWC_SetRecvDelay Sets the time delay (in ms) when sending (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

See here.

General-Purpose Ranking

General

DWC_RnkInitialize Initializes the Ranking library.
DWC_RnkInitializeDebug Initializes the Ranking library. (Used in debugging)
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_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 Parameters specified in order retrieval mode.
DWCRnkGetParam_toplist Parameters specified in top ranking list retrieval mode.
DWCRnkGetParam_nearby Parameters specified in nearby rankings list retrieval mode.
DWCRnkGetParam_friends Parameters specified in friend rankings list retrieval mode.
DWCRnkGetParam Parameters specified by DWC_RnkGetScoreAsync.

Constants, Macros, Enumerators

See here.

Download

General

DWCNdCallback Called after the various asynchronous processes of the Download library have completed.
DWC_NdInitAsync Starts initialization of the download library.
DWC_NdProcess Advances the Download library process.
DWC_NdCleanupAsync Begins closing 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.

Structures

DWCNdFileInfo The structure that stores individual file information.

Constants, Macros, Enumerators

See here.

Illegal Character String Check

General

DWC_CheckProfanityAsync Starts to check for illegal character strings.
DWC_CheckProfanityExAsync Starts checking for illegal character strings in the specified target region.
DWC_CheckProfanityProcess Proceeds with the check for illegal character strings.

Constants, Macros, Enumerators

See here.













































CONFIDENTIAL