WdfChildListRetrieveAddressDescription, fonction (wdfchildlist.h)

Article
03/01/2024

[S’applique à KMDF uniquement]

La méthode WdfChildListRetrieveAddressDescription localise un appareil enfant qui a une description d’identification spécifiée et récupère la description de l’adresse de l’appareil.

Syntaxe

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

Paramètres

[in] ChildList

Handle pour un objet de liste enfant.

[in] IdentificationDescription

Pointeur vers une structure de WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER allouée à l’appelant qui identifie une description d’identification enfant fournie par le pilote.

[in, out] AddressDescription

Pointeur vers une structure de WDF_CHILD_ADDRESS_DESCRIPTION_HEADER qui identifie une description d’adresse enfant. Le framework remplit cette description.

Valeur retournée

WdfChildListRetrieveAddressDescription retourne STATUS_SUCCESS, ou une autre valeur status pour laquelle NT_SUCCESS(status) est égal à TRUE, si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes :

Code de retour	Description
STATUS_INVALID_PARAMETER	Un paramètre d’entrée n’était pas valide.
STATUS_NO_SUCH_DEVICE	Aucun appareil ne correspondait à la description d’identification spécifiée.
STATUS_INVALID_DEVICE_REQUEST	La liste enfant ne contenait pas de descriptions d’adresses ou la taille de la description d’adresse spécifiée par AddressDescription était incorrecte.

Cette méthode peut également retourner d’autres valeurs NTSTATUS.

Un bogue système case activée se produit si le pilote fournit un handle d’objet non valide.

Remarques

Pour plus d’informations sur les listes enfants, consultez Énumération dynamique.

Exemples

L’exemple de code suivant recherche dans une liste enfant un appareil enfant dont la description d’identification contient la valeur spécifiée par SomeValue. Si WdfChildListRetrieveAddressDescription localise l’appareil, il récupère la description de l’adresse de l’appareil.

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

Configuration requise

Condition requise	Valeur
Plateforme cible	Universal
Version KMDF minimale	1.0
En-tête	wdfchildlist.h (inclure Wdf.h)
Bibliothèque	Wdf01000.sys (consultez Gestion des versions de la bibliothèque d’infrastructure).)
IRQL	<= DISPATCH_LEVEL
Règles de conformité DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)