WdfChildListRetrieveAddressDescription-Funktion (wdfchildlist.h)

Artikel
02/07/2025

[Gilt nur für KMDF]

Die WdfChildListRetrieveAddressDescription Methode sucht ein untergeordnetes Gerät mit einer angegebenen Identifikationsbeschreibung und ruft die Adressbeschreibung des Gerätsab.

Syntax

NTSTATUS WdfChildListRetrieveAddressDescription(
  [in]      WDFCHILDLIST                                 ChildList,
  [in]      PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription,
  [in, out] PWDF_CHILD_ADDRESS_DESCRIPTION_HEADER        AddressDescription
);

Parameter

[in] ChildList

Ein Handle zu einem untergeordneten Listenobjekt.

[in] IdentificationDescription

Ein Zeiger auf eine vom Aufrufer zugewiesene WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER Struktur, die eine vom Treiber bereitgestellte untergeordnete Identifikationsbeschreibung identifiziert.

[in, out] AddressDescription

Ein Zeiger auf eine WDF_CHILD_ADDRESS_DESCRIPTION_HEADER Struktur, die eine untergeordnete Adressbeschreibung identifiziert. Das Framework füllt diese Beschreibung aus.

Rückgabewert

WdfChildListRetrieveAddressDescription gibt STATUS_SUCCESS oder einen anderen Statuswert zurück, für den NT_SUCCESS(Status) gleich TRUE-ist, wenn der Vorgang erfolgreich ist. Andernfalls gibt diese Methode möglicherweise einen der folgenden Werte zurück:

Rückgabecode	Beschreibung
STATUS_INVALID_PARAMETER	Ein Eingabeparameter war ungültig.
STATUS_NO_SUCH_DEVICE	Kein Gerät entspricht der angegebenen Identifikationsbeschreibung.
STATUS_INVALID_DEVICE_REQUEST	Die untergeordnete Liste enthält keine Adressbeschreibungen, oder die Größe der Adressbeschreibung, die AddressDescription angegeben, war falsch.

Diese Methode kann auch andere NTSTATUS-Wertezurückgeben.

Eine Systemfehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.

Bemerkungen

Weitere Informationen zu untergeordneten Listen finden Sie unter dynamische Enumeration.

Beispiele

Im folgenden Codebeispiel wird eine untergeordnete Liste nach einem untergeordneten Gerät durchsucht, dessen Identifikationsbeschreibung den Wert enthält, der durch SomeValue-angegeben wird. Wenn WdfChildListRetrieveAddressDescription das Gerät findet, ruft es die Adressbeschreibung des Geräts ab.

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;
}

Anforderungen

Anforderung	Wert
Zielplattform-	Universal
Minimale KMDF-Version	1.0
Header-	wdfchildlist.h (include Wdf.h)
Library	Wdf01000.sys (siehe Framework-Bibliotheksversionsverwaltung.)
IRQL-	<= DISPATCH_LEVEL
DDI-Complianceregeln	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Siehe auch

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT

Freigeben über