WdfChildListRetrieveAddressDescription, fonction (wdfchildlist.h)

Article
02/07/2025

[S’applique uniquement à KMDF]

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 vers un objet de liste enfant.

[in] IdentificationDescription

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

[in, out] AddressDescription

Pointeur vers une structure WDF_CHILD_ADDRESS_DESCRIPTION_HEADER qui identifie une description d’adresse enfant. L’infrastructure remplit cette description.

Valeur de retour

WdfChildListRetrieveAddressDescription retourne STATUS_SUCCESS, ou une autre valeur d’état 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 :

Retourner le code	Description
STATUS_INVALID_PARAMETER	Un paramètre d’entrée n’était pas valide.
STATUS_NO_SUCH_DEVICE	Aucun appareil ne correspond à 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 de l’adresse qui AddressDescription spécifiée était incorrecte.

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

Une vérification des bogues système se produit si le pilote fournit un handle d’objet non valide.

Remarques

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

Exemples

L’exemple de code suivant recherche une liste enfant pour 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;
}

Exigences

Exigence	Valeur
plateforme cible	Universel
version minimale de KMDF	1.0
d’en-tête	wdfchildlist.h (include Wdf.h)
bibliothèque	Wdf01000.sys (voir Versioning de la bibliothèque Framework.)
IRQL	<= DISPATCH_LEVEL
règles de conformité DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Voir aussi

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER

WDF_CHILD_ADDRESS_DESCRIPTION_HEADER_INIT

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT

Partager via