WdfChildListRetrieveAddressDescription 関数 (wdfchildlist.h)
[KMDF にのみ適用]
WdfChildListRetrieveAddressDescription メソッドは、指定された 識別記述 を持つ子デバイスを検索し、デバイスの アドレスの説明を取得します。
構文
NTSTATUS WdfChildListRetrieveAddressDescription(
[in] WDFCHILDLIST ChildList,
[in] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
[in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER AddressDescription
);
パラメーター
[in] ChildList
子リスト オブジェクトへのハンドル。
[in] IdentificationDescription
ドライバーが指定した子識別の説明を識別する呼び出し元によって割り当てられた WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER 構造体へのポインター。
[in, out] AddressDescription
子アドレスの説明を識別する WDF_CHILD_ADDRESS_DESCRIPTION_HEADER 構造体へのポインター。 フレームワークはこの説明を入力します。
戻り値
WdfChildListRetrieveAddressDescription は、操作が成功した場合、STATUS_SUCCESSまたは NT_SUCCESS(状態) が TRUE 等しい別の状態値を返します。 それ以外の場合、このメソッドは次のいずれかの値を返す可能性があります。
| リターン コード | 形容 |
|---|---|
|
入力パラメーターが無効です。 |
|
指定された識別の説明に一致するデバイスがありません。 |
|
子リストにアドレスの説明が含まれていないか、指定された AddressDescription アドレスの説明のサイズが正しくありません。 |
このメソッドは、他の NTSTATUS 値返す場合もあります。
ドライバーが無効なオブジェクト ハンドルを提供すると、システム バグ チェックが発生します。
備考
例
次のコード例では、SomeValueで指定された値が識別の説明に含まれている子デバイスの子リストを検索します。 WdfChildListRetrieveAddressDescription デバイスを検索すると、デバイスのアドレスの説明が取得されます。
MY_IDENTIFICATION_DESCRIPTION id;
MY_ADDRESS_DESCRIPTION addrDescrip;
WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
&id.Header,
sizeof(id)
);
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT(
&addrDescrip.Header,
sizeof(addrDescrip)
);
id.DeviceIdentifier = SomeValue;
status = WdfChildListRetrieveAddressDescription(
list,
&idDescrip.Header,
&addrDescrip.Header
);
if (!NT_SUCCESS(status) {
return status;
}
必要条件
| 要件 | 価値 |
|---|---|
| ターゲット プラットフォーム の | 万国 |
| 最小 KMDF バージョン | 1.0 |
| ヘッダー | wdfchildlist.h (Wdf.h を含む) |
| ライブラリ | Wdf01000.sys (フレームワーク ライブラリのバージョン管理を参照)。 |
| IRQL | <= DISPATCH_LEVEL |
| DDI コンプライアンス規則 を する | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |
関連項目
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER
WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT