PFMultiplayerJoinArrangedLobby

使用另一服务提供的排列字符串 (例如匹配) 加入大厅。 如果还没有人加入大厅,则会使用配置参数初始化大厅。

语法

HRESULT PFMultiplayerJoinArrangedLobby(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* newMember,  
    const char* arrangementString,  
    const PFLobbyArrangedJoinConfiguration* configuration,  
    void* asyncContext,  
    PFLobbyHandle* lobby  
)  

参数

handle PFMultiplayerHandle

PFMultiplayer API 实例的句柄。

newMember PFEntityKey*

加入大厅的本地 PlayFab 实体。

arrangementString char*
以 null 结尾

实体用于加入大厅的排列字符串。

configuration PFLobbyArrangedJoinConfiguration*

用于初始化大厅的初始配置数据 (如果尚未有人加入大厅)。

asyncContext void*
可选

一个可选应用定义的指针大小的上下文值,可用于将完成状态更改与此调用关联起来。

lobby PFLobbyHandle*
可选、库分配的输出

可用于将操作排队以立即执行此操作的可选输出大厅对象完成。

返回值

类型:HRESULT

如果调用成功,则为 S_OK,否则为错误代码。 可通过 PFMultiplayerGetErrorMessage() 检索错误代码的可读形式。

备注

这是一个异步操作。 成功完成后,将向游戏提供 PFLobbyMemberAddedStateChange 后跟 PFLobbyJoinArrangedLobbyCompletedStateChange,其中 PFLobbyJoinArrangedLobbyCompletedStateChange::result 字段设置为 S_OK。 完成失败后,将向游戏提供 PFLobbyJoinArrangedLobbyCompletedStateChange,其中PFLobbyJoinArrangedLobbyCompletedStateChange::result 字段设置为失败。

通过此库使用匹配时,PFMatchmakingMatchDetails::lobbyArrangementString 可以与此方法一起使用,以将所有已匹配的用户一起加入大厅。

要求

标头: PFLobby.h

另请参阅

PFLobby 成员