HidP_GetExtendedAttributes関数 (hidpi.h)

  • [アーティクル]

HidP_GetExtendedAttributes ルーチンは、HID コントロールの拡張属性を返します。

構文

NTSTATUS HidP_GetExtendedAttributes(
  [in]      HIDP_REPORT_TYPE          ReportType,
  [in]      USHORT                    DataIndex,
  [in]      PHIDP_PREPARSED_DATA      PreparsedData,
  [out]     PHIDP_EXTENDED_ATTRIBUTES Attributes,
  [in, out] PULONG                    LengthAttributes
);

パラメーター

[in] ReportType

DataIndex で指定された HID コントロールに関連付けられている HID レポートの種類を示す、HIDP_REPORT_TYPE列挙子の値を指定します。

[in] DataIndex

HID コントロールの データ インデックス を指定します。

[in] PreparsedData

指定したコントロールを含む最上位のコレクションに対して準備されたデータを指定します。

[out] Attributes

DataIndex で指定されたコントロールの拡張属性を返すためにルーチンが使用する呼び出し元割り当てバッファーへのポインター。

[in, out] LengthAttributes

Attributes バッファーのサイズ (バイト単位) を指定します (sizeof(HIDP_EXTENDED_ATTRIBUTES 以上である必要があります)。

戻り値

HidP_GetExtendedAttributes は、次のいずれかの状態値を返します。

リターン コード 説明
HIDP_STATUS_SUCCESS
 ルーチンは、コントロールのすべての拡張属性情報を正常に返しました。
HIDP_STATUS_BUFFER_TOO_SMALL
 属性バッファーは、すべての拡張属性情報を保持するのに十分な大きさではありません。
HIDP_STATUS_DATA_INDEX_NOT_FOUND
 指定されたデータ インデックスが無効です。

注釈

HidP_GetExtendedAttributesは、属性バッファー内の構造体HIDP_EXTENDED_ATTRIBUTES可変長を返します。 拡張属性構造体には、固定長メンバー (NumGlobalUnknowns、 Reserved、 GlobalUnknowns) の後に、HIDP_UNKNOWN_TOKEN構造体の可変長配列 が 連続して含まれます。 不明なトークン配列の最初のメンバーは、(PHIDP_UNKNOWN_TOKEN*)&(Attributes-Data>) にあります。

ルーチンは、 属性 バッファーが保持できる数の拡張属性情報のバイト数を返します。 バッファーが小さすぎると、ルーチンは返される情報を切り捨てます。 可変長配列内の不明なトークンの数を確認するために、呼び出し元は最初に Attributes バッファーを使用して、拡張属性情報の NumGlobalUnknowns メンバーの値を返すことができます。

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

要件

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

こちらもご覧ください

HIDP_EXTENDED_ATTRIBUTES

HIDP_UNKNOWN_TOKEN

_HIDP_PREPARSED_DATA