WdfCollectionCreate 函式 (wdfcollection.h)
[適用於 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。 否則,此方法可能會傳回下列其中一個值:
傳回碼 | 描述 |
---|---|
|
呼叫端提供無效的參數值。 |
|
無法配置集合物件。 |
此方法也可能 傳回其他NTSTATUS 值。
言論
呼叫 WdfCollectionCreate 以建立架構集合對象之後,驅動程式可以呼叫 WdfCollectionAdd,將物件新增至集合。
根據預設,新集合物件的父系是建立 WdfDriverCreate 方法的架構驅動程序物件。 您可以使用 WDF_OBJECT_ATTRIBUTES 結構的 ParentObject 成員來指定不同的父代。 架構會在刪除父物件時刪除集合物件。 如果您的驅動程式未變更預設父代,驅動程式應該在使用 物件完成時刪除集合物件;否則,對象會維持在I/O管理員卸除驅動程式之前。
如需物件集合的詳細資訊,請參閱 Framework 物件集合。
例子
如需使用 WdfCollectionCreate的程式代碼範例,請參閱 WdfCollectionAdd。
要求
要求 | 價值 |
---|---|
目標平臺 | 普遍 |
最低 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) |