XblMultiplayerManagerLobbySessionInviteUsers

Article
11/05/2024

Invites the specified users to the game without displaying additional UI.

Syntax

HRESULT XblMultiplayerManagerLobbySessionInviteUsers(  
         XblUserHandle user,  
         const uint64_t* xuids,  
         size_t xuidsCount,  
         const char* contextStringId,  
         const char* customActivationContext  
)

Parameters

user _In_
Type: XblUserHandle

The user who is sending the invite.

xuids _In_
Type: uint64_t*

The array of Xbox User IDs (XUIDs) to be invited.

xuidsCount _In_
Type: size_t

The size of the xuids array.

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

Multiplayer Manager sends invites to the selected players when this function is invoked. 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.14x.GDK.C.lib

Share via