WdfCollectionGetFirstItem 関数 (wdfcollection.h)

[KMDF と UMDF に適用]

WdfCollectionGetFirstItem メソッドは、オブジェクト コレクション内の最初のオブジェクトへのハンドルを返します。

構文

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

パラメーター

[in] Collection

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

戻り値

WdfCollectionGetFirstItem は、指定したコレクションのオブジェクトのリストの先頭にあるオブジェクトへのハンドルを返します。リストが空の場合は NULL を 返します。

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

注釈

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

例

次のコード例では、コレクションから各項目を削除し、各項目の オブジェクトを削除します。

while ((subRequest = WdfCollectionGetFirstItem(hCollection)) != NULL) {
    WdfCollectionRemoveItem(
                            hCollection,
                            0
                            );
    WdfObjectDelete(subRequest);
}

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
最小 UMDF バージョン	2.0
Header	wdfcollection.h (Wdf.h を含む)
Library	Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL	<= DISPATCH_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)

こちらもご覧ください

WdfCollectionGetItem

WdfCollectionGetLastItem