XblMultiplayerManagerLobbySessionInviteFriends

Article
06/22/2023

Displays the standard Xbox UI, allowing the user to select friends or recent players and invite them to the game.

Syntax

HRESULT XblMultiplayerManagerLobbySessionInviteFriends(  
         XblUserHandle requestingUser,  
         const char* contextStringId,  
         const char* customActivationContext  
)

Parameters

requestingUser _In_
Type: XblUserHandle

The user who is sending the invite.

contextStringId _In_opt_z_
Type: char*

Optional. The custom context string ID, a string that is defined during Xbox Live ingestion, to identify the custom invitation text that is added to the standard invitation text. The ID string must be prefixed with three slash characters (" /// ").

customActivationContext _In_opt_z_
Type: char*

Optional. The activation context string, a game-defined string that is passed to the invited game client and interpreted as desired by the game.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

If this function is invoked, Multiplayer Manager sends invites to the selected players when the user confirms the player selection in the standard Xbox UI. If a selected player accepts the invite, the title is notified. For GDK-based games, the title is notified by invoking the callback function specified when the XGameInviteRegisterForEvent function was invoked. For games based on other platforms, the title is activated. For more information, see Receiving invites.

Requirements

Header: multiplayer_manager_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

Share via