XblMultiplayerActivitySetActivityAsync

设置或更新本地用户的多人游戏活动。

语法

HRESULT XblMultiplayerActivitySetActivityAsync(  
         XblContextHandle xblContext,  
         const XblMultiplayerActivityInfo* activityInfo,  
         bool allowCrossPlatformJoin,  
         XAsyncBlock* async  
)  

参数

xblContext _In_
类型:XblContextHandle

适用于本地用户的 Xbox Live 上下文。

activityInfo _In_
类型:XblMultiplayerActivityInfo*

有关活动的信息。 " maxPlayers "和" currentPlayers 字段是可选的;"如果设置为 0, 它们会被忽略。 字段 platform 的值被忽略; XSAPI 在适当的本地平台上自动设置活动。

allowCrossPlatformJoin _In_
类型:bool

如果活动应在游戏支持的其他平台上可加入,则为 True。

async _In_
类型:XAsyncBlock*

此操作的 XAsyncBlock

返回值

类型:HRESULT

此 API 操作的 HRESULT 返回代码。

备注

每当游戏开始或加入多人游戏体验时,都应该创建一个活动。 通过此操作,可以让 shell 和你游戏中的其他玩家看到玩家的活动。 你的游戏可以让其他玩家加入正在进行的游戏。 如果有玩家想加入游戏的某一活动但该活动尚未运行,则将激活该活动并向其传递连接字符串。

若要了解如何使用此函数,请参阅 多玩家活动示例代码活动 部分的“设置活动”。

REST 调用

调用 PUT /titles/{titleId}/users/{xuid}/activites

要求

标头: multiplayer_activity_c.h

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

另请参阅

multiplayer_activity_c