PFLobbyLeave

请求一个或所有本地用户离开大厅。

语法

HRESULT PFLobbyLeave(  
    PFLobbyHandle lobby,  
    const PFEntityKey* localUser,  
    void* asyncContext  
)  

参数

lobby PFLobbyHandle

大厅的句柄。

localUserPFEntityKey*
可选

一个可选值,用于指示特定本地用户是否应离开大厅。 如果此值为 nullptr,则所有本地用户都将离开大厅。

asyncContext void*
可选

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

返回值

类型:HRESULT

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

备注

此方法将异步操作排队,以从大厅中删除一个或所有本地用户。 完成后,将提供 PFLobbyLeaveLobbyCompletedStateChange ,指示操作已完成。

此方法不保证休假成功。 由于网络或服务错误,操作可能会失败。 如果离开尝试失败但可重试,库将继续重试离开操作。 否则,本地客户端会将请求的本地成员与大厅断开连接,但将其保留为成员。 在重新加入之前,它们将保持为断开连接的成员。

此方法不能由game_server实体调用。

要求

标头: PFLobby.h

另请参阅

PFLobby 成员