WdfChildListUpdateChildDescriptionAsMissing, fonction (wdfchildlist.h)

Article
02/07/2025

[S’applique uniquement à KMDF]

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

Syntaxe

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

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 .

Valeur de retour

WdfChildListUpdateChildDescriptionAsMissing 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_INVALID_DEVICE_REQUEST	La taille de la structure à laquelle IdentificationDescription points était incorrecte.
STATUS_NO_SUCH_DEVICE	L’appareil spécifié n’a pas été trouvé dans la liste enfant.

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

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 par WdfChildListEndScan, au lieu d’appeler WdfChildListUpdateChildDescriptionAsMissing pour chaque appareil.

Pour plus d’informations sur les appareils enfants et les listes enfants, consultez d’é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
                                                     );

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_IDENTIFICATION_DESCRIPTION_HEADER

WDF_CHILD_IDENTIFICATION_DESCRIPTION_HEADER_INIT

WdfChildListAddOrUpdateChildDescriptionAsPresent

Partager via