Função WdfCollectionCreate (wdfcollection.h)
[Aplica-se a KMDF e UMDF]
O método WdfCollectionCreate cria um objeto de coleção de estruturas.
Sintaxe
NTSTATUS WdfCollectionCreate(
[in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
[out] WDFCOLLECTION *Collection
);
Parâmetros
[in, optional] CollectionAttributes
Um ponteiro para uma estrutura de WDF_OBJECT_ATTRIBUTES alocada pelo chamador que contém atributos para o novo objeto de coleção. Esse parâmetro é opcional e pode ser WDF_NO_OBJECT_ATTRIBUTES.
[out] Collection
Um ponteiro para um local que recebe um identificador para o novo objeto de coleção.
Retornar valor
WdfCollectionCreate retornará STATUS_SUCCESS se a operação for bem-sucedida. Caso contrário, esse método pode retornar um dos seguintes valores:
| Código de retorno | Descrição |
|---|---|
|
O chamador forneceu um valor de parâmetro inválido. |
|
Não foi possível alocar um objeto de coleção. |
Esse método também pode retornar outros valores NTSTATUS.
Comentários
Depois de chamar WdfCollectionCreate para criar um objeto de coleção de estruturas, um driver pode chamar WdfCollectionAdd para adicionar objetos à coleção.
Por padrão, o pai do novo objeto de coleção é o objeto de driver de estrutura que o método WdfDriverCreate criou. Você pode usar o membro ParentObject da estrutura WDF_OBJECT_ATTRIBUTES para especificar um pai diferente. A estrutura exclui o objeto da coleção quando exclui o objeto pai. Se o driver não alterar o pai padrão, o driver deverá excluir o objeto da coleção quando terminar de usar o objeto ; caso contrário, o objeto permanecerá até que o gerenciador de E/S descarregue o driver.
Para obter mais informações sobre coleções de objetos, consulte Coleções de objetos framework.
Exemplos
Para obter um exemplo de código que usa WdfCollectionCreate, consulte WdfCollectionAdd.
Requisitos
| Requisito | Valor |
|---|---|
| Plataforma de Destino | Universal |
| Versão mínima do KMDF | 1.0 |
| Versão mínima do UMDF | 2,0 |
| Cabeçalho | wdfcollection.h (include Wdf.h) |
| Biblioteca | Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF) |
| IRQL | <= DISPATCH_LEVEL |
| Regras de conformidade da DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |