WdfCollectionCreate, fonction (wdfcollection.h)
[S’applique à KMDF et UMDF]
La méthode WdfCollectionCreate crée un objet de collection d’infrastructure.
Syntaxe
NTSTATUS WdfCollectionCreate(
[in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
[out] WDFCOLLECTION *Collection
);
Paramètres
[in, optional] CollectionAttributes
Pointeur vers une structure 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 de retour
WdfCollectionCreate retourne STATUS_SUCCESS si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes :
| Retourner le code | Description |
|---|---|
|
L’appelant a fourni une valeur de paramètre non valide. |
|
Impossible d’allouer un objet collection. |
Cette méthode peut également retourner d’autres valeurs NTSTATUS .
Remarques
Après avoir appelé WdfCollectionCreate pour créer un objet de collection d’infrastructure, un pilote peut appeler WdfCollectionAdd pour ajouter des objets à la collection.
Par défaut, le parent de l’objet de la nouvelle collection est l’objet de pilote framework que la méthode WdfDriverCreate créée. Vous pouvez utiliser le membre ParentObject de la structure WDF_OBJECT_ATTRIBUTES pour spécifier un parent différent. L’infrastructure 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 une fois l’objet terminé à l’aide de l’objet ; sinon, l’objet reste jusqu’à ce que le gestionnaire d’E/S décharge votre pilote.
Pour plus d’informations sur les collections d’objets, consultez Framework Object Collections.
Exemples
Pour obtenir un exemple de code qui utilise WdfCollectionCreate, consultez WdfCollectionAdd .
Exigences
| Exigence | Valeur |
|---|---|
| plateforme cible | Universel |
| version minimale de KMDF | 1.0 |
| version minimale de UMDF | 2.0 |
| d’en-tête | wdfcollection.h (include 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) |