WdfChildListUpdateChildDescriptionAsMissing 関数 (wdfchildlist.h)
[KMDF にのみ適用]
WdfChildListUpdateChildDescriptionAsMissing メソッドは、指定された子デバイスが現在取り外されているか、使用できないことをフレームワークに通知します。
構文
NTSTATUS WdfChildListUpdateChildDescriptionAsMissing(
[in] WDFCHILDLIST ChildList,
[in] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription
);
パラメーター
[in] ChildList
子リスト オブジェクトへのハンドル。
[in] IdentificationDescription
ドライバーによって提供される子 識別の説明を識別する呼び出し元によって割り当てられた WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 構造体へのポインター。
戻り値
WdfChildListUpdateChildDescriptionAsMissing は、操作が成功した場合、STATUS_SUCCESS、または NT_SUCCESS(status) が TRUE 等しい別の状態値を返します。 それ以外の場合、このメソッドは次のいずれかの値を返す可能性があります。
| リターン コード | 形容 |
|---|---|
|
入力パラメーターが無効です。 |
|
IdentificationDescription ポイント 構造体のサイズが正しくありません。 |
|
指定したデバイスが子リストに見つかりませんでした。 |
このメソッドは、他の NTSTATUS 値返す場合もあります。
ドライバーが無効なオブジェクト ハンドルを提供すると、システム バグ チェックが発生します。
備考
ドライバーは、デバイスが存在したことを報告するために WdfChildListAddOrUpdateChildDescriptionAsPresent 呼び出されていなくても、デバイスが使用できないことを報告できます。 この場合、WdfChildListUpdateChildDescriptionAsMissing メソッドはSTATUS_NO_SUCH_DEVICEを返すだけです。
子リスト内のすべてのデバイスが使用できないことを報告する場合、ドライバーは、WdfChildListUpdateChildDescriptionAsMissing を呼び出す代わりに、WdfChildListBeginScanを呼び出し、その直後に WdfChildListEndScan 呼び出すことができます。
子デバイスと子リストの詳細については、「動的列挙 をする」を参照してください。
例
次のコード例は、指定したシリアル番号を持つ子デバイスが使用できないことをフレームワークに通知します。
PDO_IDENTIFICATION_DESCRIPTION description;
NTSTATUS status;
WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
&description.Header,
sizeof(description)
);
description.SerialNo = SerialNo;
status = WdfChildListUpdateChildDescriptionAsMissing(
list,
&description.Header
);
必要条件
| 要件 | 価値 |
|---|---|
| ターゲット プラットフォーム の | 万国 |
| 最小 KMDF バージョン | 1.0 |
| ヘッダー | wdfchildlist.h (Wdf.h を含む) |
| ライブラリ | Wdf01000.sys (フレームワーク ライブラリのバージョン管理を参照)。 |
| IRQL | <= DISPATCH_LEVEL |
| DDI コンプライアンス規則 を する | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |
関連項目
WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER