WdfChildListRequestChildEject 関数 (wdfchildlist.h)
[KMDF にのみ適用]
WdfChildListRequestChildEject メソッドは、指定されたデバイスがドッキング ステーションから取り出されようとしていることをフレームワークに通知します。
構文
BOOLEAN WdfChildListRequestChildEject(
[in] WDFCHILDLIST ChildList,
[in] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription
);
パラメーター
[in] ChildList
子リスト オブジェクトへのハンドル。
[in] IdentificationDescription
呼び出し元によって割り当てられた WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 構造体へのポインター。
戻り値
操作が成功した場合、WdfChildListRequestChildEject は TRUE を 返します。 入力パラメーターが無効な場合、またはフレームワークが子リストでデバイスを見つけることができない場合、メソッドは FALSE を返します。
ドライバーが無効なオブジェクト ハンドルを提供すると、システム バグ チェックが発生します。
注釈
バス ドライバーは 、WdfChildListRequestChildEject または WdfPdoRequestEject を呼び出して、列挙された子デバイスの 1 つをデバイスのドッキング ステーションから取り出そうとしたことをドライバーが検出したことを報告できます。 たとえば、ドライバーは、ユーザーが取り出しボタンをプッシュしたことを検出する場合があります。
ドライバーが動的バス列挙を使用していて、デバイスの識別の説明が使用可能な場合、ドライバーは WdfChildListRequestChildEject を呼び出すことができます。 デバイスの PDO のフレームワーク デバイス オブジェクトが使用可能な場合、ドライバーは WdfPdoRequestEject を呼び出すことができます。
WdfChildListRequestChildEject メソッドの IdentificationDescription パラメーターは、取り出されるデバイスを識別します。 デバイスは、 ChildList パラメーターが表す子リストのメンバーである必要があります。
フレームワークでは、識別の説明を使用して、子リスト内のデバイスを検索します。
子リストの詳細については、「 動的列挙」を参照してください。
イジェクタブル デバイスの詳細については、「 イジェクタブル デバイスのサポート」を参照してください。
例
WdfChildListRequestChildEject を使用するコード例については、「WdfChildListRetrieveNextDevice」を参照してください。
要件
要件 | 値 |
---|---|
対象プラットフォーム | ユニバーサル |
最小 KMDF バージョン | 1.0 |
Header | wdfchildlist.h (Wdf.h を含む) |
Library | Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。 |
IRQL | <= DISPATCH_LEVEL |
DDI コンプライアンス規則 | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |