XblMultiplayerGetSearchHandlesAsync
関連付けられている検索ハンドルでセッションを検索します。
構文
HRESULT XblMultiplayerGetSearchHandlesAsync(
XblContextHandle xblContext,
const char* scid,
const char* sessionTemplateName,
const char* orderByAttribute,
bool orderAscending,
const char* searchFilter,
const char* socialGroup,
XAsyncBlock* async
)
パラメーター
xblContext _In_
型: XblContextHandle
ローカル ユーザーの Xbox Live コンテキスト。
scid _In_z_
型: char*
検索ハンドルを照会するサービス構成 ID (SCID)。 SCID は大文字と小文字が区別されると見なされるため、パートナー センターから直接貼り付けます
sessionTemplateName _In_z_
型: char*
検索ハンドルをクエリするテンプレートの名前。
orderByAttribute_In_opt_z_
型: char*
検索ハンドルの並び替え基準の属性を指定します。 空の文字列を渡すと、"タイムスタンプの昇順" で並び替える既定の設定になります。
orderAscending _In_
型: bool
true を渡すと昇順で並び替え、false を渡すと降順で並び替えます。
searchFilter _In_opt_z_
型: char*
検索ハンドルを取得する対象のクエリ文字列。
socialGroup _In_opt_z_
型: char*
検索ハンドルを取得する対象のソーシャル グループ。
async _In_
型: XAsyncBlock*
この操作の AsyncBlock。
戻り値
型: HRESULT
この API 操作の HRESULT 結果コード。
解説
検索ハンドルのフィルタリング: クエリの構文は、OData に似た構文で、サポートされる演算子は EQ、NE、GE、GT、LE、LT と、論理演算子の AND と OR のみです。 例 1: 特定の XboxUserId の検索ハンドルをフィルタリングするには、"MemberXuids/any(d:d eq '12345678')" または "OwnerXuids/any(d:d eq '12345678')" を使用します。例 2: タイトル定義の文字列メタデータの検索ハンドルをフィルタリングするには、"Strings/stringMetadataType eq 'value'" を使用します。例 3: タイトル定義の数値メタデータの検索ハンドルとタグ タイプ値の検索ハンドルを AND でフィルタリングするには、"Numbers/numberMetadataType eq 53 AND Tags/tagType eq 'value'" を使用します。空のフィルターとソーシャル グループ: Since searchFilter と socialGroup は省略可能であるため、不要な場合や使用しない場合は nullptr を渡すようにしてください。 空の文字列 "" を渡すことはできません。
要件
ヘッダー: multiplayer_c.h
ライブラリ: Microsoft.Xbox.Services.14x.GDK.C.lib