Fungsi WdfCollectionCreate (wdfcollection.h)

  • Artikel

[Berlaku untuk KMDF dan UMDF]

Metode WdfCollectionCreate membuat objek pengumpulan kerangka kerja.

Sintaks

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

Parameter

[in, optional] CollectionAttributes

Penunjuk ke struktur WDF_OBJECT_ATTRIBUTES yang dialokasikan penelepon yang berisi atribut untuk objek koleksi baru. Parameter ini bersifat opsional dan dapat WDF_NO_OBJECT_ATTRIBUTES.

[out] Collection

Penunjuk ke lokasi yang menerima handel ke objek koleksi baru.

Nilai kembali

WdfCollectionCreate mengembalikan STATUS_SUCCESS jika operasi berhasil. Jika tidak, metode ini mungkin mengembalikan salah satu nilai berikut:

Menampilkan kode Deskripsi
STATUS_INVALID_PARAMETER
 Pemanggil menyediakan nilai parameter yang tidak valid.
STATUS_INSUFFICIENT_RESOURCES
 Objek koleksi tidak dapat dialokasikan.
 

Metode ini mungkin juga mengembalikan nilai NTSTATUS lainnya.

Keterangan

Setelah memanggil WdfCollectionCreate untuk membuat objek koleksi kerangka kerja, driver dapat memanggil WdfCollectionAdd untuk menambahkan objek ke koleksi.

Secara default, induk objek koleksi baru adalah objek driver kerangka kerja yang dibuat metode WdfDriverCreate . Anda dapat menggunakan anggota ParentObject dari struktur WDF_OBJECT_ATTRIBUTES untuk menentukan induk yang berbeda. Kerangka kerja menghapus objek koleksi saat menghapus objek induk. Jika driver Anda tidak mengubah induk default, driver harus menghapus objek koleksi setelah selesai menggunakan objek ; jika tidak, objek akan tetap ada sampai manajer I/O membongkar driver Anda.

Untuk informasi selengkapnya tentang koleksi objek, lihat Koleksi Objek Kerangka Kerja.

Contoh

Untuk contoh kode yang menggunakan WdfCollectionCreate, lihat WdfCollectionAdd.

Persyaratan

Persyaratan Nilai
Target Platform Universal
Versi KMDF minimum 1,0
Versi UMDF minimum 2.0
Header wdfcollection.h (termasuk Wdf.h)
Pustaka Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
Aturan kepatuhan DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

Lihat juga

WDF_OBJECT_ATTRIBUTES

WdfCollectionAdd

WdfCollectionRemove

WdfDriverBuat