DWC_GetGroupID

Syntax

#include <dwc.h>
u32 DWC_GetGroupID(void);

Arguments

None.

Return Values

The ID of the group to which the local host currently belongs. This function returns 0 when it could not get the group ID.

Description

Gets the ID of the group to which the local host currently belongs.

If the local host saves the group ID, it can be used to try to reconnect to a group to which the local host had once belonged. This function returns a valid value beginning from the point in time when the DWCMatchedSCCallback function (specified by DWC_ConnectToAnybodyAsync, DWC_ConnectToFriendsAsync, DWC_SetupGameServer, DWC_ConnectToGameServerAsync, or DWC_ConnectToGameServerByGroupID) is called with error==DWC_ERROR_NONE. (The local host is in this state when it has connected with another player at least once.)

Revision History

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL