次の方法で共有


PFLobbyGetSearchPropertyKeys

検索プロパティ キーの一覧を取得します。

構文

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

パラメーター

lobby PFLobbyHandle

ロビーのハンドル。

propertyCount uint32_t*
出力

検索プロパティの出力数。

keys char* const**
ライブラリに割り当てられた、サイズが *propertyCount の出力配列

検索プロパティ キーの出力配列。

戻り値

型: HRESULT

呼び出しが成功した場合は S_OK、それ以外の場合はエラー コードになります。 人間が読める形式のエラー コードは、PartyManager::GetErrorMessage() を介して取得できます。

解説

検索プロパティは、ロビーの検索結果のフィルター処理と並べ替えに使用できるメタデータとしてロビーのメンバー以外に表示されます。

このロビー オブジェクトが、PFMultiplayerCreateAndJoinLobby()PFMultiplayerCreateAndClaimServerLobbyPFMultiplayerClaimServerLobby() または PFMultiplayerJoinLobby() の呼び出しを介して非同期に作成、結合、または要求される処理中の場合、このメソッドはキーを返しません。

要件

ヘッダー: PFLobby.h

関連項目

PFLobby メンバー