WdfCollectionCreate-Funktion (wdfcollection.h)

  • Artikel

[Gilt für KMDF und UMDF]

Die WdfCollectionCreate-Methode erstellt ein Frameworksammlungsobjekt.

Syntax

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

Parameter

[in, optional] CollectionAttributes

Ein Zeiger auf eine vom Aufrufer zugewiesene WDF_OBJECT_ATTRIBUTES Struktur, die Attribute für das neue Auflistungsobjekt enthält. Dieser Parameter ist optional und kann WDF_NO_OBJECT_ATTRIBUTES werden.

[out] Collection

Ein Zeiger auf eine Position, die ein Handle auf das neue Auflistungsobjekt empfängt.

Rückgabewert

WdfCollectionCreate gibt STATUS_SUCCESS zurück, wenn der Vorgang erfolgreich ist. Andernfalls gibt diese Methode möglicherweise einen der folgenden Werte zurück:

Rückgabecode Beschreibung
STATUS_INVALID_PARAMETER
 Der Aufrufer hat einen ungültigen Parameterwert angegeben.
STATUS_INSUFFICIENT_RESOURCES
 Ein Auflistungsobjekt konnte nicht zugeordnet werden.
 

Diese Methode gibt möglicherweise auch andere NTSTATUS-Werte zurück.

Hinweise

Nach dem Aufrufen von WdfCollectionCreate zum Erstellen eines Frameworksammlungsobjekts kann ein Treiber WdfCollectionAdd aufrufen, um der Auflistung Objekte hinzuzufügen.

Standardmäßig ist das übergeordnete Element des neuen Auflistungsobjekts das Frameworktreiberobjekt, das von der WdfDriverCreate-Methode erstellt wurde. Sie können den ParentObject-Member der WDF_OBJECT_ATTRIBUTES-Struktur verwenden, um ein anderes übergeordnetes Element anzugeben. Das Framework löscht das Auflistungsobjekt, wenn es das übergeordnete Objekt löscht. Wenn der Treiber das übergeordnete Standardobjekt nicht ändert, sollte der Treiber das Auflistungsobjekt löschen, wenn er die Verwendung des -Objekts abgeschlossen hat. Andernfalls verbleibt das Objekt, bis der E/A-Manager Den Treiber entladen hat.

Weitere Informationen zu Objektauflistungen finden Sie unter Framework-Objektauflistungen.

Beispiele

Ein Codebeispiel, das WdfCollectionCreate verwendet, finden Sie unter WdfCollectionAdd.

Anforderungen

Anforderung Wert
Zielplattform Universell
KMDF-Mindestversion 1.0
UMDF-Mindestversion 2.0
Kopfzeile wdfcollection.h (einschließen von Wdf.h)
Bibliothek Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
DDI-Complianceregeln DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Weitere Informationen

WDF_OBJECT_ATTRIBUTES

WdfCollectionAdd

WdfCollectionRemove

WdfDriverErstellen