WdfCollectionCreate 函式 (wdfcollection.h)

發行項
02/26/2024

[適用於 KMDF 和 UMDF]

WdfCollectionCreate 方法會建立架構集合物件。

語法

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

參數

[in, optional] CollectionAttributes

呼叫端配置的 WDF_OBJECT_ATTRIBUTES 結構的指標，其中包含新集合對象的屬性。此參數是選擇性的，而且可以WDF_NO_OBJECT_ATTRIBUTES。

[out] Collection

接收新集合物件句柄的位置指標。

傳回值

如果作業成功，WdfCollectionCreate 會傳回STATUS_SUCCESS。否則，此方法可能會傳回下列其中一個值：

傳回碼	Description
STATUS_INVALID_PARAMETER	呼叫端提供了無效的參數值。
STATUS_INSUFFICIENT_RESOURCES	無法配置集合物件。

這個方法也可能傳回其他 NTSTATUS值。

備註

呼叫 WdfCollectionCreate 以建立架構集合對象之後，驅動程式可以呼叫 WdfCollectionAdd 將物件新增至集合。

根據預設，新集合物件的父系是 WdfDriverCreate 方法所建立的架構驅動程序物件。您可以使用 WDF_OBJECT_ATTRIBUTES 結構的 ParentObject 成員來指定不同的父代。架構會在刪除父物件時刪除集合物件。如果您的驅動程式未變更預設父代，則驅動程式在使用物件完成時，應該刪除集合物件;否則，對象會維持不變，直到 I/O 管理員卸除驅動程序為止。

如需物件集合的詳細資訊，請參閱 Framework 物件集合。

範例

如需使用 WdfCollectionCreate 的程式代碼範例，請參閱 WdfCollectionAdd。

規格需求

需求	值
目標平台	Universal
最小 KMDF 版本	1.0
最低UMDF版本	2.0
標頭	wdfcollection.h (包含 Wdf.h)
程式庫	Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL	<= DISPATCH_LEVEL
DDI 合規性規則	DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)