ClusterRegEnumValue 函式 (clusapi.h)

發行項
08/22/2023

列舉開放式叢集資料庫索引鍵的值。

語法

DWORD ClusterRegEnumValue(
  [in]                HKEY    hKey,
  [in]                DWORD   dwIndex,
  [out]               LPWSTR  lpszValueName,
  [in, out]           LPDWORD lpcchValueName,
  [out, optional]     LPDWORD lpdwType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

參數

[in] hKey

要列舉的叢集資料庫索引鍵控制碼。

[in] dwIndex

用來識別要列舉之下一個值的索引。第一次呼叫 ClusterRegEnumValue 時，此參數應該是零，然後針對後續呼叫遞增。

因為值未排序，所以任何新值都有任意索引。這表示 ClusterRegEnumValue 可以依任何順序傳回值。

[out] lpszValueName

Null 終止的 Unicode 字串指標，其中包含傳回值的名稱。

[in, out] lpcchValueName

lpszValueName緩衝區大小做為字元計數的指標。在輸入上，指定緩衝區可以保留的最大字元數，包括終止 的 Null。在輸出上，指定結果名稱中的字元數，不包括終止 的 Null。

[out, optional] lpdwType

值專案的型別程式碼指標，如果不需要類型代碼，則為 Null 。類型程式碼可以是下列其中一個值。

REG_BINARY (3)

任何形式的二進位資料，

REG_DWORD (4)

32 位數位。

REG_DWORD_BIG_ENDIAN (5)

以大端格式儲存的 32 位數位。

REG_EXPAND_SZ (2)

Null 終止的 Unicode 字串，其中包含環境變數的未展開參考 (，例如「%PATH%」) 。

REG_MULTI_SZ (6)

以 Null 結尾的字串序列，由空字串終止， (\0) 。

以下是一個範例：

String1\0String2\0String3\0LastString\0\0

第一個 \0 會終止第一個字串，第二個到最後一個 \0 會終止最後一個字串，最後一個 \0 會終止序列。請注意，最終結束字元必須納入字串的長度。

REG_NONE (0)

沒有定義的實值型別。

REG_QWORD (11)

64 位數位。

REG_SZ (1)

以 Null 結尾的 Unicode 字串。

[out, optional] lpData

值專案之資料的指標。如果不需要資料，此參數可以是 Null 。

[in, out, optional] lpcbData

在輸入時，指標指向 lpbData 參數所指向之緩衝區中的位元組計數。在輸出上，指標指向作業所產生的位元組計數。只有當lpbData為Null時，此參數才能為Null。

傳回值

函式會傳回下列其中一個值。

傳回碼/值	Description
ERROR_SUCCESS 0 (0x0)	作業成功。
ERROR_NO_MORE_ITEMS 259 (0x103)	不會再傳回任何值。
ERROR_MORE_DATA 234 (0xEA)	其中一個輸出緩衝區 (lpszValueName 或 lpbData) 太小，無法保存產生的資料。 lpcchValueName和lpbData參數會指出所需的大小 (請注意，lpcchValueName不包含字元計數中終止的Null) 。
系統錯誤碼	作業失敗。

規格需求


最低支援的用戶端	都不支援
最低支援的伺服器	Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
目標平台	Windows
標頭	clusapi.h
程式庫	ClusAPI.lib
Dll	ClusAPI.dll

另請參閱

ClusterRegOpenKey

共用方式為