RegEnumKeyA 函式 (winreg.h)

列舉指定之已開啟登錄機碼的子機碼。函式會在每次呼叫時擷取一個子機碼的名稱。

注意此函式僅適用於與16位版本的Windows相容。應用程式應該使用 RegEnumKeyEx 函式。

語法

LSTATUS RegEnumKeyA(
  [in]  HKEY  hKey,
  [in]  DWORD dwIndex,
  [out] LPSTR lpName,
  [in]  DWORD cchName
);

[in] hKey

開啟登錄機碼的句柄。金鑰必須已以KEY_ENUMERATE_SUB_KEYS訪問許可權開啟。如需詳細資訊，請參閱登錄機碼安全性和訪問許可權。

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in] dwIndex

要擷取 之 hKey 子機碼的索引。第一次呼叫 RegEnumKey 函 式時，此值應該是零，然後針對後續呼叫遞增。

因為子機碼未排序，所以任何新的子機碼都會有任意索引。這表示函式可以依任何順序傳回子機碼。

[out] lpName

接收子機碼名稱之緩衝區的指標，包括終止的 Null 字元。此函式只會將子機碼的名稱，而不是完整金鑰階層複製到緩衝區。

如需詳細資訊，請參閱登錄專案大小限制。

[in] cchName

TCHAR 中 lpName 參數所指向的緩衝區大小。若要判斷所需的緩衝區大小，請使用 RegQueryInfoKey 函式來判斷 hKey 參數所識別金鑰的最大子機碼大小。

如果函式成功，傳回值會ERROR_SUCCESS。

如果函式失敗，則傳回值是系統錯誤碼。如果沒有其他可用的子機碼，函式會傳回ERROR_NO_MORE_ITEMS。

如果 lpName 緩衝區太小而無法接收索引鍵的名稱，則函式會傳回ERROR_MORE_DATA。

若要列舉子機碼，應用程式一開始應該呼叫 RegEnumKey 函式， 並將 dwIndex 參數設定為零。然後，應用程式應該遞增 dwIndex 參數並呼叫 RegEnumKey 函式，直到沒有任何子機碼 (表示函式傳回ERROR_NO_MORE_ITEMS) 。

應用程式也可以在第一次呼叫函式時，將 dwIndex 設定為最後一個索引鍵的索引，並遞減索引，直到列舉具有索引 0 的子機碼為止。若要擷取最後一個子機碼的索引，請使用 RegQueryInfoKey。

當應用程式使用 RegEnumKey 函 式時，它不應該呼叫任何可能會變更所查詢金鑰的註冊函式。

注意

winreg.h 標頭會將 RegEnumKey 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。