WdfCollectionCreate, fonction (wdfcollection.h)

  • Article

[S’applique à KMDF et UMDF]

La méthode WdfCollectionCreate crée un objet de collection framework.

Syntaxe

NTSTATUS WdfCollectionCreate(
  [in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
  [out]          WDFCOLLECTION          *Collection
);

Paramètres

[in, optional] CollectionAttributes

Pointeur vers une structure de WDF_OBJECT_ATTRIBUTES allouée par l’appelant qui contient des attributs pour le nouvel objet de collection. Ce paramètre est facultatif et peut être WDF_NO_OBJECT_ATTRIBUTES.

[out] Collection

Pointeur vers un emplacement qui reçoit un handle vers le nouvel objet de collection.

Valeur retournée

WdfCollectionCreate retourne STATUS_SUCCESS si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes :

Code de retour Description
STATUS_INVALID_PARAMETER
 L’appelant a fourni une valeur de paramètre non valide.
STATUS_INSUFFICIENT_RESOURCES
 Impossible d’allouer un objet de collection.
 

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

Remarques

Après avoir appelé WdfCollectionCreate pour créer un objet de collection framework, un pilote peut appeler WdfCollectionAdd pour ajouter des objets à la collection.

Par défaut, le parent du nouvel objet de collection est l’objet de pilote d’infrastructure créé par la méthode WdfDriverCreate . Vous pouvez utiliser le membre ParentObject de la structure WDF_OBJECT_ATTRIBUTES pour spécifier un autre parent. Le framework supprime l’objet de collection lorsqu’il supprime l’objet parent. Si votre pilote ne modifie pas le parent par défaut, le pilote doit supprimer l’objet de collection lorsqu’il a terminé d’utiliser l’objet ; sinon, l’objet restera jusqu’à ce que le gestionnaire d’E/S décharge votre pilote.

Pour plus d’informations sur les collections d’objets, consultez Collections d’objets Framework.

Exemples

Pour obtenir un exemple de code qui utilise WdfCollectionCreate, consultez WdfCollectionAdd.

Configuration requise

Condition requise Valeur
Plateforme cible Universal
Version KMDF minimale 1.0
Version UMDF minimale 2.0
En-tête wdfcollection.h (inclure Wdf.h)
Bibliothèque Wdf01000.sys (KMDF) ; WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
Règles de conformité DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Voir aussi

WDF_OBJECT_ATTRIBUTES

WdfCollectionAjouter

WdfCollectionRemove

WdfDriverCréer