通过

PFLobbyGetSearchProperty

  • 项目

从其键中获取搜索属性值。

语法

HRESULT PFLobbyGetSearchProperty(  
    PFLobbyHandle lobby,  
    const char* key,  
    const char** value  
)

参数

lobby PFLobbyHandle

大厅的句柄。

key char*
以 null 结尾

属性的键。

value char**
库分配的输出，可能返回 nullptr

与该键关联的输出值。 输出 null 值表示属性不存在。

返回值

类型：HRESULT

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

备注

搜索属性对大厅的非成员可见为元数据，可用于筛选和排序大厅搜索结果。

如果此大厅对象仍处于通过调用 PFMultiplayerCreateAndJoinLobby()、PFMultiplayerCreateAndClaimServerLobby、PFMultiplayerClaimServerLobby() 或 PFMultiplayerJoinLobby() 异步创建、加入或认领的过程中，此方法将不返回任何属性。

要求

标头： PFLobby.h

另请参阅

PFLobby 成员