PFLobbyGetSearchPropertyKeys

获取搜索属性键的列表。

语法

HRESULT PFLobbyGetSearchPropertyKeys(  
    PFLobbyHandle lobby,  
    uint32_t* propertyCount,  
    const char* const** keys  
)  

参数

lobby PFLobbyHandle

大厅的句柄。

propertyCount uint32_t*
输出

搜索属性的输出计数。

keys char* const**
大小为 *propertyCount 的库分配的输出数组

搜索属性键的输出数组。

返回值

类型:HRESULT

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

备注

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

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

要求

标头: PFLobby.h

另请参阅

PFLobby 成员