WdfRegistryQueryUnicodeString 函式 (wdfregistry.h)

發行項
03/01/2024

[適用於 KMDF 和 UMDF]

WdfRegistryQueryUnicodeString 方法會擷取目前指派給指定登錄字串值的字串串數據，並將字元串複製到指定的UNICODE_STRING結構。

語法

NTSTATUS WdfRegistryQueryUnicodeString(
  [in]            WDFKEY           Key,
  [in]            PCUNICODE_STRING ValueName,
  [out, optional] PUSHORT          ValueByteLength,
  [in, out]       PUNICODE_STRING  Value
);

參數

[in] Key

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

[in] ValueName

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

[out, optional] ValueByteLength

位置的指標，這個位置會接收 Value 所指向的 Unicode 字元串中包含的位元組數目，包括終止 的 NULL 位元組。此指標是選擇性的，可以是 NULL

[in, out] Value

UNICODE_STRING 結構的指標，該結構會接收 Key 所指定索引鍵的數據字串。如果此參數為 NULL 且 ValueByteLength 為非 NULL，WdfRegistryQueryUnicodeString 只會傳回字串的大小。

傳回值

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

傳回碼	Description
STATUS_INVALID_DEVICE_REQUEST	在 IRQL = PASSIVE_LEVEL未呼叫 WdfRegistryQueryUnicodeString。
STATUS_INVALID_PARAMETER	指定了無效的參數。
STATUS_INSUFFICIENT_RESOURCES	記憶體不足，無法完成作業。
STATUS_ACCESS_DENIED	驅動程式未使用KEY_QUERY_VALUE、KEY_READ或KEY_ALL_ACCESS存取來開啟登錄機碼。
STATUS_OBJECT_TYPE_MISMATCH	未REG_SZ指定 ValueName 參數之登錄值的數據類型。
STATUS_BUFFER_OVERFLOW	Value 參數指向的緩衝區太小，而且只會將部分數據寫入緩衝區。
STATUS_BUFFER_OVERFLOW	Value 參數指向的緩衝區太小，而且不會將數據寫入緩衝區。
STATUS_OBJECT_NAME_NOT_FOUND	登錄值無法使用。

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

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

備註

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

範例

下列程式代碼範例是來自序列範例驅動程式，會擷取 Unicode 字串，代表指派給裝置硬體機碼下 PortName 值的字串數據。

NTSTATUS
SerialReadSymName(
    IN WDFDEVICE Device,
    __out PWCHAR RegName,
    IN OUT PUSHORT LengthOfRegName // In characters
    )
{
    NTSTATUS status;
    WDFKEY hKey;
    UNICODE_STRING value;
    UNICODE_STRING valueName;
    USHORT requiredLength;

    value.Buffer = RegName;
    value.MaximumLength = *LengthOfRegName;
    value.Length = 0;

    status = WdfDeviceOpenRegistryKey(
                                      Device,
                                      PLUGPLAY_REGKEY_DEVICE,
                                      STANDARD_RIGHTS_ALL,
                                      WDF_NO_OBJECT_ATTRIBUTES,
                                      &hKey
                                      );

    if (NT_SUCCESS (status)) {
        RtlInitUnicodeString(
                             &valueName,
                             L"PortName"
                             );
        status = WdfRegistryQueryUnicodeString (
                                      hKey,
                                      &valueName,
                                      &requiredLength,
                                      &value
                                      );
        WdfRegistryClose(hKey);
    }
    return status;
}

規格需求

需求	值
目標平台	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)