PFMultiplayerClaimServerLobby

声明预先存在的服务器大厅的所有权。

语法

HRESULT PFMultiplayerClaimServerLobby(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* server,  
    const char* lobbyId,  
    void* asyncContext,  
    PFLobbyHandle* lobby  
)  

参数

handle PFMultiplayerHandle

PFMultiplayer API 实例的句柄。

serverPFEntityKey*

声明大厅的游戏服务器的 PlayFab 实体密钥。 它的实体类型必须为“game_server”。

lobbyId char*
以 null 结尾

要声明的大厅的 ID。

asyncContext void*
可选

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

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

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

返回值

类型:HRESULT

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

备注

若要使用此功能,必须在包含 PFLobby.h 之前定义PFMULTIPLAYER_INCLUDE_SERVER_APIS。

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

此操作主要用于支持game_server拥有服务器拥有的主机已断开连接或将断开连接的大厅的所有权的实体。 通常,这对于想要将所有权迁移到另 game_server一个game_server实体或game_server实体的实体非常感兴趣,这些实体需要在发生一些严重故障后恢复其自己的服务器的所有权,从而导致它们失去对大厅句柄的访问权限,例如崩溃。

游戏服务器不能声明另一个game_server实体当前连接到的大厅的所有权。

要求

标头: PFLobby.h

另请参阅

PFLobby 成员