DWC_IsBuddyFriendData

Syntax

#include <dwc.h>
BOOL DWC_IsBuddyFriendData(const DWCFriendData *frienddata);

Arguments

frienddata Pointer to the buffer for the DWCFriendData structure that stores the friend information.

Return Values

TRUE Friend relationship has been established.
FALSE Friend relationship has not been established.

Description

For the friend information specified by frienddata, this function checks if a friendship is already established on the GameSpy server.

When a friend relationship is established on the GameSpy server, the friend-established flag in the friend information is set.
Also, the flag in the friend information used for checking whether the other party recognizes you as a friend is updated whenever the DWC_UpdateServersAsync function is called and whenever the other party sends a request to form a friend relationship and the request is acknowledged.

These two flags are checked to determine whether a friend relationship has been established. In other words, this function returns TRUE (that is, a friendship has been established) only when both parties mutually recognize the friendship. Note, however, that the flags in the other party's friend information are not updated in real time. (This function does not perform any communications.)

See Also

DWC_UpdateServersAsync
DWC_WasBuddyFriendData

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL