WdfChildListRetrieveAddressDescription-Funktion (wdfchildlist.h)

Artikel
08/08/2023

[Gilt nur für KMDF]

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

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 für ein untergeordnetes Listenobjekt.

[in] IdentificationDescription

Ein Zeiger auf eine vom Aufrufer zugeordnete 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 status Wert 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 entsprach der angegebenen Identifizierungsbeschreibung.
STATUS_INVALID_DEVICE_REQUEST	Die untergeordnete Liste enthielt keine Adressbeschreibungen, oder die Größe der Adressbeschreibung, die AddressDescription angegeben hat, war falsch.

Diese Methode gibt möglicherweise auch andere NTSTATUS-Werte zurück.

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

Hinweise

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 von SomeValue angegebenen Wert enthält. Wenn WdfChildListRetrieveAddressDescription das Gerät findet, wird die Adressbeschreibung des Geräts abgerufen.

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	Universell
KMDF-Mindestversion	1.0
Kopfzeile	wdfchildlist.h (include Wdf.h)
Bibliothek	Wdf01000.sys (siehe Versionsverwaltung der Frameworkbibliothek).)
IRQL	<= DISPATCH_LEVEL
DDI-Complianceregeln	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Weitere Informationen

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT