#include <dwc.h>
void DWC_CreateFriendKeyToken( DWCFriendData* token, u64 friend_key );
Uses the friend registration key to create friend information to add to the friend roster. Create friend registration keys to send to another user using the DWC_CreateFriendKey function.
When using this function to create friend information, be absolutely sure to check the validity of the friend registration key in advance using the DWC_CheckFriendKey function.
When registering friend information in the friend roster, first check all of the friend information on the roster using the DWC_IsEqualFriendData function to verify that the information is not already registered. This will avoid duplicate data registration. Next, use the DWC_IsValidFriendData function to search for a location in the roster that does not contain valid data. Copy the obtained friend information directly to the friend roster at that location.
When you want to delete friend information from the friend roster, call the DWC_DeleteBuddyFriendData function. When offline, friend information is zero-cleared. The next time the DWC_UpdateServersAsync function is called, the friend-related information on the GameSpy server will be deleted. When online, friend information is zero-cleared and the friend-related information on the GameSpy server is deleted immediately.
The friend roster may sometimes automatically change while online, based on a request from a GameSpy server. To edit the friend roster while online, use the DWC_CanChangeFriendList function to check whether or not the list can be edited.
To establish friend relationship by editing the friend roster while online, use the DWC_UpdateServersAsync function.
Note: Starting from NITRO-DWC 3.0, a different method is employed to generate the value used to check the validity of friend registration keys. Because of this change, the friend registration keys created with older versions of NITRO-DWC are no longer compatible. If for some special reason you need to be able to deal with these legacy friend registration keys, use the DWC_CreateFriendKeyLegacy function and the DWC_CheckFriendKeyLegacy function.
token |
Pointer to the buffer where the friend information to be added to the friend roster is stored |
friend_key |
Friend registration key |
None.
DWC_CreateExchangeToken ,
DWC_CheckFriendKey ,
DWC_CreateFriendKey ,
DWC_IsEqualFriendData,
DWC_IsValidFriendData,
DWC_DeleteBuddyFriendData,
DWC_CanChangeFriendList,
DWC_UpdateServersAsync
2008/03/02 Added text about compatibility with older specification.
2008/01/16 Added warning about the compatibility of friend registration keys.
2007/06/22 Added text about checking the validity of friend registration keys.
2005/12/16 Revisions.
2005/10/26 Revisions.
2005/10/20 Initial version.
CONFIDENTIAL