HidP_GetLinkCollectionNodes 関数 (hidpi.h)

HidP_GetLinkCollectionNodes ルーチンは、最上位のコレクションのリンク コレクション配列を返します。

構文

NTSTATUS HidP_GetLinkCollectionNodes(
  [out]     PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes,
  [in, out] PULONG                     LinkCollectionNodesLength,
  [in]      PHIDP_PREPARSED_DATA       PreparsedData
);

パラメーター

[out] LinkCollectionNodes

HidP_GetLinkCollectionNodesが最上位のコレクションのリンク コレクション配列 を返す HIDP_LINK_COLLECTION_NODE構造体の呼び出し元によって割り当てられた配列へのポインター。

[in, out] LinkCollectionNodesLength

入力時に、 LinkCollectionNodes バッファーの配列要素の長さを指定します。 出力時に、ルーチンは LinkCollectionNodesLength を、設定した配列内のエントリの数に設定します。

[in] PreparsedData

このルーチンがリンク コレクション配列を返す最上位のコレクションの準備済みデータへのポインター。

戻り値

HidP_GetLinkCollectionNodes は、次のいずれかの状態コードを返します。

リターン コード	説明
HIDP_STATUS_SUCCESS	ルーチンは、指定されたコレクションのリンク コレクション配列を正常に返しました。
HIDP_STATUS_INVALID_PREPARSED_DATA	準備されたデータが無効です。
HIDP_STATUS_BUFFER_TOO_SMALL	LinkCollectionNodes バッファーが小さすぎて、リンク コレクション配列全体を保持できません。

注釈

LinkCollectionNodes バッファーの必要な長さは、コレクションのHIDP_CAPS構造体の NumberLinkCollectionNodes メンバーによって指定されます。

HidP_GetLinkCollectionNodesがHIDP_STATUS_BUFFER_TOO_SMALL状態値を返す場合は、LinkCollectionNodesLength も、リンク コレクション ノードの情報を保持するために必要な配列要素の長さに設定します。

詳細については、「 HID コレクション」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム	ユニバーサル
Header	hidpi.h (Hidpi.h を含む)
Library	Hidparse.lib
IRQL	<= DISPATCH_LEVEL

こちらもご覧ください

HIDP_CAPS

HIDP_LINK_COLLECTION_NODE

HidP_GetCaps

_HIDP_PREPARSED_DATA