XblMultiplayerManagerLobbySessionInviteUsers

邀请指定的用户加入游戏,而不显示其他 UI。

语法

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

参数

user _In_
类型:XblUserHandle

正发送邀请的用户。

xuids _In_
类型:uint64_t*

将要邀请的 Xbox 用户 ID(XUID)的数组。

xuidsCount _In_
类型:size_t

xuids 数组的大小。

contextStringId _In_opt_z_
类型:char*

可选。 自定义内容字符串 ID,此字符串是在 Xbox Live 引入期间定义的,用于识别附加到标准邀请文字的自定义邀请文字。 ID 字符串必须以三个左斜线(“///”)为前缀。

customActivationContext _In_opt_z_
类型:char*

可选。 激活内容字符串,这是游戏定义的字符串,可传递给受邀请的游戏客户端并按游戏所需进行解释。

返回值

类型:HRESULT

此 API 操作的 HRESULT 返回代码。

备注

调用此函数时,多人游戏管理器会向所选玩家发送邀请。 如果所选玩家接受邀请,将通知游戏。 对于基于 GDK 的游戏,通过调用 XGameInviteRegisterForEvent 函数时指定的回调函数来通知游戏。 对于基于其他平台的游戏,将激活游戏。 有关详细信息,请参阅接受邀请

要求

头文件:multiplayer_manager_c.h

图书馆: Microsoft.Xbox.Services.14x.GDK.C.lib

另请参阅

multiplayer_manager_c
XblMultiplayerManagerJoinLobby
XblMultiplayerManagerLobbySessionAddLocalUser
XblMultiplayerManagerLobbySessionInviteFriends