ZwEnumerateKey 函式 (wdm.h)

發行項
02/29/2024

ZwEnumerateKey 例程會傳回開啟登錄機碼之子機碼的相關信息。

語法

NTSYSAPI NTSTATUS ZwEnumerateKey(
  [in]            HANDLE                KeyHandle,
  [in]            ULONG                 Index,
  [in]            KEY_INFORMATION_CLASS KeyInformationClass,
  [out, optional] PVOID                 KeyInformation,
  [in]            ULONG                 Length,
  [out]           PULONG                ResultLength
);

參數

[in] KeyHandle

包含要列舉之子機碼的登錄機碼句柄。句柄是由成功呼叫 ZwCreateKey 或 ZwOpenKey 所建立。

[in] Index

您想要資訊的子機碼索引。如果索引鍵有 n 個子機碼，子機碼會從 0 編號為 n-1。

[in] KeyInformationClass

指定 KEY_INFORMATION_CLASS 列舉值，決定 KeyInformation 緩衝區要接收的資訊類型。將 KeyInformationClass 設定為下列其中一個值：

KeyBasicInformation
KeyFullInformation
KeyNodeInformation

如果未在此清單中指定任何值，則例程會傳回錯誤碼STATUS_INVALID_PARAMETER。

[out, optional] KeyInformation

接收所要求資訊的呼叫端配置緩衝區指標。 KeyInformationClass 參數會決定提供的資訊類型。

[in] Length

指定 KeyInformation 緩衝區的大小，以位元組為單位。

[out] ResultLength

接收登錄機碼資訊的位元組大小之變數指標。如果 ZwEnumerateKey 傳回STATUS_SUCCESS，您可以使用此變數的值來判斷傳回的數據量。如果例程傳回STATUS_BUFFER_OVERFLOW或STATUS_BUFFER_TOO_SMALL，您可以使用此變數的值來判斷保存密鑰資訊所需的緩衝區大小。

傳回值

ZwEnumerateKey 會在成功時傳回STATUS_SUCCESS，或在失敗時傳回適當的 NTSTATUS 錯誤碼。可能的錯誤碼值包括：

傳回碼	Description
STATUS_BUFFER_OVERFLOW	提供的緩衝區太小，而且只有部分數據已寫入緩衝區。 *ResultLength 會設定為保存要求資訊所需的最小大小。
STATUS_BUFFER_TOO_SMALL	提供的緩衝區太小，而且沒有任何數據寫入緩衝區。 *ResultLength 會設定為保存要求資訊所需的最小大小。
STATUS_INVALID_PARAMETER	KeyInformationClass 參數不是有效的KEY_INFORMATION_CLASS值。
STATUS_NO_MORE_ENTRIES	Index 值超出 KeyHandle 所指定登錄機碼的範圍。例如，如果索引鍵有 n 個子機碼，則針對大於 n-1 的任何值，例程會傳回STATUS_NO_MORE_ENTRIES。

備註

句柄必須以KEY_ENUMERATE_SUB_KEYS存取權開啟。這可藉由將KEY_ENUMERATE_SUB_KEYS、KEY_READ或KEY_ALL_ACCESS當做 DesiredAccess 參數傳遞至 ZwCreateKey 或 ZwOpenKey 來完成。

Index 參數只是在 KeyHandle 所參考之索引鍵的子機碼之間選取的方法。使用相同 Index 對 ZwEnumerateKey 的兩次呼叫不保證會傳回相同的結果。

如需使用登錄機碼的詳細資訊，請參閱在驅動程式中使用登錄。

如果在使用者模式中呼叫此函式，您應該使用名稱「NtEnumerateKey」而不是「ZwEnumerateKey」。

針對來自內核模式驅動程式的呼叫，Windows 原生系統服務例程的 NtXxx 和 ZwXxx 版本會以處理和解譯輸入參數的方式，以不同的方式運作。如需 例程 NtXxx 和 ZwXxx 版本之間關聯性的詳細資訊，請參閱使用原生系統服務例程的 Nt 和 Zw 版本。

規格需求

需求	值
目標平台	Universal
標頭	wdm.h (包括 Wdm.h、Ntddk.h、Ntifs.h)
程式庫	NtosKrnl.lib
Dll	NtosKrnl.exe
IRQL	PASSIVE_LEVEL
DDI 合規性規則	HwStorPortProhibitedDIS (storport) 、 IrqlZwPassive (wdm) 、 PowerIrpDDis (wdm) 、 ZwRegistryCreate (storport) 、 ZwRegistryCreate (storport) ， ZwRegistryCreate (wdm) 、 ZwRegistryOpen (storport) 、ZwRegistryOpen (storport) 、 ZwRegistryOpen (wdm)