Funzione WdfCollectionCreate (wdfcollection.h)

  • Articolo

[Si applica a KMDF e UMDF]

Il metodo WdfCollectionCreate crea un oggetto raccolta framework.

Sintassi

NTSTATUS WdfCollectionCreate(
  [in, optional] PWDF_OBJECT_ATTRIBUTES CollectionAttributes,
  [out]          WDFCOLLECTION          *Collection
);

Parametri

[in, optional] CollectionAttributes

Puntatore a una struttura WDF_OBJECT_ATTRIBUTES allocata dal chiamante che contiene attributi per il nuovo oggetto raccolta. Questo parametro è facoltativo e può essere WDF_NO_OBJECT_ATTRIBUTES.

[out] Collection

Puntatore a una posizione che riceve un handle per il nuovo oggetto raccolta.

Valore restituito

WdfCollectionCreate restituisce STATUS_SUCCESS se l'operazione ha esito positivo. In caso contrario, questo metodo potrebbe restituire uno dei valori seguenti:

Codice restituito Descrizione
STATUS_INVALID_PARAMETER
 Il chiamante ha fornito un valore di parametro non valido.
STATUS_INSUFFICIENT_RESOURCES
 Impossibile allocare un oggetto raccolta.
 

Questo metodo potrebbe anche restituire altri valori NTSTATUS.

Commenti

Dopo aver chiamato WdfCollectionCreate per creare un oggetto raccolta framework, un driver può chiamare WdfCollectionAdd per aggiungere oggetti alla raccolta.

Per impostazione predefinita, il padre del nuovo oggetto raccolta è l'oggetto driver del framework creato dal metodo WdfDriverCreate . È possibile utilizzare il membro ParentObject della struttura WDF_OBJECT_ATTRIBUTES per specificare un elemento padre diverso. Il framework elimina l'oggetto raccolta quando elimina l'oggetto padre. Se il driver non modifica l'elemento padre predefinito, il driver deve eliminare l'oggetto raccolta al termine dell'utilizzo dell'oggetto ; in caso contrario, l'oggetto rimarrà finché il gestore di I/O non scarica il driver.

Per altre informazioni sulle raccolte di oggetti, vedere Framework Object Collections.

Esempio

Per un esempio di codice che usa WdfCollectionCreate, vedere WdfCollectionAdd.

Requisiti

Requisito Valore
Piattaforma di destinazione Universale
Versione KMDF minima 1.0
Versione UMDF minima 2,0
Intestazione wdfcollection.h (include Wdf.h)
Libreria Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
Regole di conformità DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Vedi anche

WDF_OBJECT_ATTRIBUTES

WdfCollectionAggiungi

WdfCollectionRemove

WdfDriverCreate