PFLobbyGetSearchPropertyKeys
Get the list of search property keys.
Syntax
HRESULT PFLobbyGetSearchPropertyKeys(
PFLobbyHandle lobby,
uint32_t* propertyCount,
const char* const** keys
)
Parameters
lobby PFLobbyHandle
The handle of the lobby.
propertyCount uint32_t*
output
The output count of search properties.
keys char* const**
library-allocated output array of size *propertyCount
The output array of search property keys.
Return value
Type: HRESULT
S_OK if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PFMultiplayerGetErrorMessage().
Remarks
Search properties are visible to non-members of the lobby as metadata which can be used to filter and sort lobby search results.
If this lobby object is still in the process of asynchronously being created, joined, or claimed via a call to PFMultiplayerCreateAndJoinLobby(), PFMultiplayerCreateAndClaimServerLobby, PFMultiplayerClaimServerLobby() or PFMultiplayerJoinLobby(), this method will return no keys.
Requirements
Header: PFLobby.h