Compartilhar via


Função WdfCollectionGetFirstItem (wdfcollection.h)

[Aplica-se a KMDF e UMDF]

O método WdfCollectionGetFirstItem retorna um identificador para o primeiro objeto que está em uma coleção de objetos.

Sintaxe

WDFOBJECT WdfCollectionGetFirstItem(
  [in] WDFCOLLECTION Collection
);

Parâmetros

[in] Collection

Um identificador para um objeto de coleção.

Valor de retorno

WdfCollectionGetFirstItem retorna um identificador para o objeto que está atualmente na frente da lista de objetos da coleção especificada ou NULL se a lista estiver vazia.

Uma verificação de bug ocorre se o driver fornece um identificador de objeto inválido.

Observações

Para obter mais informações sobre coleções de objetos, consulte Coleções de Objetos da Estrutura.

Exemplos

O exemplo de código a seguir remove cada item de uma coleção e exclui o objeto de cada item.

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

Requisitos

Requisito Valor
da Plataforma de Destino Universal
versão mínima do KMDF 1.0
versão mínima do UMDF 2.0
cabeçalho wdfcollection.h (inclua Wdf.h)
biblioteca Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
regras de conformidade de DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Consulte também

WdfCollectionGetItem

WdfCollectionGetLastItem