PFLobbyGetServerProperty

Get the lobby server property's value from its key.

Syntax

HRESULT PFLobbyGetServerProperty(  
    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

If this lobby isn't a client-owned lobby, no property value is returned.

Requirements

Header: PFLobby.h

See also

PFLobby members