WdfChildListUpdateChildDescriptionAsMissing, fonction (wdfchildlist.h)

Article
02/29/2024

[S’applique à KMDF uniquement]

La méthode WdfChildListUpdateChildDescriptionAsMissing informe l’infrastructure qu’un appareil enfant spécifié est actuellement débranché ou indisponible.

Syntaxe

NTSTATUS WdfChildListUpdateChildDescriptionAsMissing(
  [in] WDFCHILDLIST                                 ChildList,
  [in] PWDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER IdentificationDescription
);

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 par l’appelant qui identifie une description d’identification enfant fournie par le pilote.

Valeur retournée

WdfChildListUpdateChildDescriptionAsMissing retourne STATUS_SUCCESS, ou une autre valeur de 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_INVALID_DEVICE_REQUEST	La taille de la structure vers laquelle IdentificationDescription pointe était incorrecte.
STATUS_NO_SUCH_DEVICE	L’appareil spécifié est introuvable dans la liste enfant.

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

Votre pilote peut signaler qu’un appareil n’est pas disponible même si le pilote n’a jamais appelé WdfChildListAddOrUpdateChildDescriptionAsPresent pour signaler que l’appareil était présent. Dans ce cas, la méthode WdfChildListUpdateChildDescriptionAsMissing retourne simplement STATUS_NO_SUCH_DEVICE.

Si vous souhaitez signaler que tous les appareils d’une liste enfant ne sont pas disponibles, votre pilote peut simplement appeler WdfChildListBeginScan, suivi immédiatement de WdfChildListEndScan, au lieu d’appeler WdfChildListUpdateChildDescriptionAsMissing pour chaque appareil.

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

Exemples

L’exemple de code suivant informe l’infrastructure qu’un appareil enfant avec un numéro de série spécifié n’est pas disponible.

PDO_IDENTIFICATION_DESCRIPTION  description;
NTSTATUS  status;

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT(
                                                 &description.Header,
                                                 sizeof(description)
                                                 );

description.SerialNo = SerialNo;
status = WdfChildListUpdateChildDescriptionAsMissing(
                                                     list,
                                                     &description.Header
                                                     );

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)

Voir aussi

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT

WdfChildListAddOrUpdateChildDescriptionAsPresent

Partager via