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 puede ser 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
STATUS_INVALID_PARAMETER	El autor de la llamada proporcionó un valor de parámetro no válido.
STATUS_INSUFFICIENT_RESOURCES	No se pudo asignar un objeto de colección.

 

Este método también podría devolver otros valores NTSTATUS.

Comentarios

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 método WdfDriverCreate . Puede usar el miembro ParentObject de la estructura WDF_OBJECT_ATTRIBUTES para especificar otro elemento primario. 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 Colecciones de objetos framework.

Ejemplos

Para obtener un ejemplo de código que usa WdfCollectionCreate, vea WdfCollectionAdd.

Requisitos

Requisito	Value
Plataforma de destino	Universal
Versión mínima de KMDF	1.0
Versión mínima de UMDF	2.0
Encabezado	wdfcollection.h (incluir Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	<= DISPATCH_LEVEL
Reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Consulte también

WDF_OBJECT_ATTRIBUTES

WdfCollectionAdd

WdfCollectionRemove

WdfDriverCreate