Edit

Share via

PFLobbyGetLobbyProperty

  • Article

Get the lobby property value from its key.

Syntax

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

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

key   char*
is null-terminated

The key of the property.

value   char**
library-allocated output, may return nullptr

The output value associated with the key. An output null value signifies the property wasn't present.

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

Lobby properties are only visible to members of the lobby.

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 properties.

Requirements

Header: PFLobby.h

See also

PFLobby members