Función WdfCollectionCreate (wdfcollection.h)
[Se aplica a KMDF y UMDF]
El método WdfCollectionCreate crea un objeto de colección de marcos.
Sintaxis
NTSTATUS WdfCollectionCreate(
[in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
[out] WDFCOLLECTION *Collection
);
Parámetros
[in, optional] CollectionAttributes
Puntero a una estructura de WDF_OBJECT_ATTRIBUTES asignada por el autor de la llamada que contiene atributos para el nuevo objeto de colección. Este parámetro es opcional y se puede WDF_NO_OBJECT_ATTRIBUTES.
[out] Collection
Puntero a una ubicación que recibe un identificador para el nuevo objeto de colección.
Valor devuelto
WdfCollectionCreate devuelve STATUS_SUCCESS si la operación se realiza correctamente. De lo contrario, este método podría devolver uno de los siguientes valores:
| Código devuelto | Descripción |
|---|---|
|
El autor de la llamada proporcionó un valor de parámetro no válido. |
|
No se pudo asignar un objeto de colección. |
Este método también puede devolver otros valores de NTSTATUS.
Observaciones
Después de llamar a WdfCollectionCreate para crear un objeto de colección de marcos, un controlador puede llamar a WdfCollectionAdd para agregar objetos a la colección.
De forma predeterminada, el nuevo objeto primario del objeto de colección es el objeto de controlador de marco que creó el WdfDriverCreate método. Puede usar el miembro parentObject de de la estructura WDF_OBJECT_ATTRIBUTES para especificar un elemento primario diferente. El marco elimina el objeto de colección cuando elimina el objeto primario. Si el controlador no cambia el elemento primario predeterminado, el controlador debe eliminar el objeto de colección cuando haya terminado de usar el objeto ; De lo contrario, el objeto permanecerá hasta que el administrador de E/S descargue el controlador.
Para obtener más información sobre las colecciones de objetos, vea Framework Object Collections.
Ejemplos
Para obtener un ejemplo de código que usa WdfCollectionCreate, vea WdfCollectionAdd.
Requisitos
| Requisito | Valor |
|---|---|
| de la plataforma de destino de | Universal |
| versión mínima de KMDF | 1.0 |
| versión mínima de UMDF | 2.0 |
| encabezado de | wdfcollection.h (incluya Wdf.h) |
| biblioteca de | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| irQL | <= DISPATCH_LEVEL |
| reglas de cumplimiento de DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |