DWC_SetFriendStatusCallback

Syntax

#include <dwc.h>
BOOL DWC_SetFriendStatusCallback(DWCFriendStatusCallback callback,
                                 void *param);

Arguments

callback Pointer to the callback function that notifies the user about changes to friend status.
param Callback parameter.

Return Values

TRUE Configuration of the callback function was successful.
FALSE The configuration failed because the FriendsMatch library was not running.

Description

Configures the callback function that is called when a friend's communication status changes. For more details about the communication status, see the description of the DWC_GetFriendStatus function.

This callback function is usually set via an argument of the friend roster synchronization function DWC_UpdateServersAsync. However, if you want to know the communication status of friends in real time even when no friend roster synchronization is needed, use this function to set a callback.

The callback function set here is called every time a friend's communication status changes.

Note: The callback function set by this function will be overwritten if the DWC_UpdateServersAsync function is called.

Revision History

5.1 PR2
Added the fact that the callback function is overwritten by the DWC_UpdateServersAsync function.

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL