WdfRegistryQueryMultiString 函式 (wdfregistry.h)

發行項
02/27/2024

[適用於 KMDF 和 UMDF]

WdfRegistryQueryMultiString 方法會擷取目前指派給指定之多字串登錄值的字串、為每個字串建立架構字串物件，並將每個字元串物件新增至指定的物件集合。

語法

NTSTATUS WdfRegistryQueryMultiString(
  [in]           WDFKEY                 Key,
  [in]           PCUNICODE_STRING       ValueName,
  [in, optional] PWDF_OBJECT_ATTRIBUTES StringsAttributes,
  [in]           WDFCOLLECTION          Collection
);

參數

[in] Key

代表已開啟登錄機碼之登錄機碼物件的句柄。

[in] ValueName

包含值名稱之UNICODE_STRING 結構的指標。

[in, optional] StringsAttributes

WDF_OBJECT_ATTRIBUTES 結構的指標，其中包含每個新字串對象的物件屬性。這個參數是選擇性的，而且可以WDF_NO_OBJECT_ATTRIBUTES。

[in] Collection

驅動程式提供的架構集合物件的句柄。

傳回值

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

傳回碼	Description
STATUS_INVALID_DEVICE_REQUEST	在 IRQL = PASSIVE_LEVEL 未呼叫 WdfRegistryQueryMultiString。
STATUS_INVALID_PARAMETER	指定了無效的參數。
STATUS_INSUFFICIENT_RESOURCES	無法設定字串物件。
STATUS_ACCESS_DENIED	驅動程式未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS存取來開啟登錄機碼。
STATUS_OBJECT_TYPE_MISMATCH	未REG_MULTI_SZ指定 ValueName 參數的登錄值數據類型。
STATUS_OBJECT_NAME_NOT_FOUND	登錄值無法使用。
STATUS_RESOURCE_DATA_NOT_FOUND	登錄值存在於指定的機碼底下，但是空的。

如需 WdfRegistryQueryMultiString 方法可能傳回的其他傳回值清單，請參閱 Framework 物件建立錯誤。

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

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

在驅動程式呼叫 WdfRegistryQueryMultiString 之前，它必須呼叫 WdfCollectionCreate 來建立集合物件。

如果呼叫端未提供 StringsAttributes 參數，則架構所建立的任何 WDFSTRING 物件預設都會父代至 WDFDRIVER。

在 WdfRegistryQueryMultiString 傳回之後，驅動程式可以呼叫 WdfCollectionGetCount 來取得擷取的字串數目和 WdfCollectionGetItem，以從集合取得字符串物件。

如果集合包含驅動程式呼叫 WdfRegistryQueryMultiString 方法之前的物件，則方法不會移除這些物件或變更其索引值。新的物件會附加至集合結尾。

若要從字串物件取得字串，驅動程式可以呼叫 WdfStringGetUnicodeString。

如需登錄機碼對象的詳細資訊，請參閱在 Framework-Based Drivers 中使用登錄。

範例

下列程式代碼範例會建立集合物件、初始化 WDF_OBJECT_ATTRIBUTES 結構，讓集合對象成為架構為集合建立之所有字串物件的父代，並從多字串登錄值擷取字元串。最後，此範例會取得架構新增至集合的字串物件數目。

WDF_OBJECT_ATTRIBUTES stringAttributes;
WDFCOLLECTION col;
NTSTATUS status;
ULONG count;
DECLARE_CONST_UNICODE_STRING(valueMultiSz, VALUE_MULTI_SZ);

status = WdfCollectionCreate(
                             NULL,
                             &col
                             );
ASSERT(NT_SUCCESS(status));

WDF_OBJECT_ATTRIBUTES_INIT(&stringAttributes);
stringAttributes.ParentObject = col;

status = WdfRegistryQueryMultiString(
                                     Key,
                                     &valueMultiSzEmpty,
                                     &stringAttributes,
                                     col
                                     );

count = WdfCollectionGetCount(col);

規格需求

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