DWC_CreateFriendKeyToken

C Specification

#include <dwc.h>

void DWC_CreateFriendKeyToken( DWCFriendData* token, u64 friend_key );

Description

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 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 DWC_IsValidFriendData to search for a location in the roster that does not contain valid data and directly copy the obtained friend information 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.

Arguments

token Pointer to the buffer where the friend information to be added to the friend roster is stored
friend_key Friend registration key

Return Values

None.

See Also

DWC_CreateExchangeToken , DWC_CheckFriendKey , DWC_CreateFriendKey , DWC_IsEqualFriendData, DWC_IsValidFriendData, DWC_DeleteBuddyFriendData, DWC_CanChangeFriendList, DWC_UpdateServersAsync

Revision History

12/16/2005 Revisions.
10/26/2005 Revisions.
10/20/2005 Initial version.