Función WdfCollectionGetFirstItem (wdfcollection.h)

  • Artículo

[Se aplica a KMDF y UMDF]

El método WdfCollectionGetFirstItem devuelve un identificador al primer objeto que se encuentra en una colección de objetos.

Sintaxis

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

Parámetros

[in] Collection

Identificador de un objeto de colección.

Valor devuelto

WdfCollectionGetFirstItem devuelve un identificador al objeto que está actualmente en la parte delantera de la lista de objetos de la colección especificada o NULL si la lista está vacía.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Comentarios

Para obtener más información sobre las colecciones de objetos, vea Colecciones de objetos framework.

Ejemplos

En el ejemplo de código siguiente se quita cada elemento de una colección y se elimina el objeto de cada elemento.

while ((subRequest = WdfCollectionGetFirstItem(hCollection)) != NULL) {
    WdfCollectionRemoveItem(
                            hCollection,
                            0
                            );
    WdfObjectDelete(subRequest);
}

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

WdfCollectionGetItem

WdfCollectionGetLastItem