WdfCollectionGetItem 関数 (wdfcollection.h)

[KMDF と UMDF に適用]

WdfCollectionGetItem メソッドは、指定したオブジェクト コレクションに含まれており、指定したインデックス値に関連付けられているオブジェクトへのハンドルを返します。

構文

WDFOBJECT WdfCollectionGetItem(
  [in] WDFCOLLECTION Collection,
  [in] ULONG         Index
);

パラメーター

[in] Collection

コレクション オブジェクトへのハンドル。

[in] Index

コレクション内のオブジェクトを識別する 0 から始まるインデックス値。

戻り値

WdfCollectionGetItem はフレームワーク オブジェクト ハンドルを返します。Index 値が無効な場合は NULL を返します。

ドライバーが無効なオブジェクト ハンドルを提供すると、システム バグ チェックが発生します。

注釈

インデックス値は、オブジェクトがコレクションに追加される順序を表します。 インデックス値 0 はコレクション内の最初のオブジェクトを表し、1 のインデックス値は 2 番目のオブジェクトを表し、リンクリストのように同様に表します。 ドライバーがコレクションから項目 i を削除すると、項目 i+1 は項目 i になります。

オブジェクト コレクションの詳細については、「 Framework オブジェクト コレクション」を参照してください。

例

WdfCollectionGetItem を使用するコード例については、「WdfCollectionGetCount」を参照してください。

要件

こちらもご覧ください

WdfCollectionGetFirstItem

WdfCollectionGetLastItem