Freigeben über


PFLobbyGetSearchProperty

Ruft den Sucheigenschaftswert aus seinem Schlüssel ab.

Syntax

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

Parameter

lobby PFLobbyHandle

Der Griff des Wartebereichs.

key Char*
ist NULL-terminiert.

Der Schlüssel der Eigenschaft.

value Char**
bibliotheksseitig zugeordnete Ausgabe, kann nullptr zurückgeben

Der Ausgabewert, der dem Schlüssel zugeordnet ist. Ein Ausgabe-NULL-Wert gibt an, dass die Eigenschaft nicht vorhanden war.

Rückgabewert

Typ: HRESULT

S_OK , wenn der Aufruf erfolgreich war oder andernfalls ein Fehlercode vorliegt. Die lesbare Form des Fehlercodes kann über PFMultiplayerGetErrorMessage() abgerufen werden.

Hinweise

Sucheigenschaften sind für Nichtmitglieder des Wartebereichs als Metadaten sichtbar, die zum Filtern und Sortieren von Lobby-Suchergebnissen verwendet werden können.

Wenn dieses Lobbyobjekt immer noch asynchron erstellt, verknüpft oder über einen Aufruf von PFMultiplayerCreateAndJoinLobby(), PFMultiplayerCreateAndClaimServerLobby, PFMultiplayerClaimServerLobby() oder PFMultiplayerJoinLobby() beansprucht wird, gibt diese Methode keine Eigenschaften zurück.

Voraussetzungen

Header: PFLobby.h

Weitere Informationen

PFLobby-Member