ClusterRegQueryValue 函式 (clusapi.h)

發行項
03/05/2024

傳回與開啟叢集資料庫索引鍵值相關聯的名稱、類型和數據元件。

語法

LONG ClusterRegQueryValue(
  [in]                HKEY    hKey,
  [in]                LPCWSTR lpszValueName,
  [out, optional]     LPDWORD lpdwValueType,
  [out, optional]     LPBYTE  lpData,
  [in, out, optional] LPDWORD lpcbData
);

參數

[in] hKey

要查詢的叢集資料庫密鑰句柄。

[in] lpszValueName

Null 終止 Unicode 字串的指標，其中包含要查詢之值的名稱。

[out, optional] lpdwValueType

索引鍵值類型的指標。如果不需要類型，此參數可以是 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 的內容中。

只有在 lpbData 也是 NULL 時，lpbData 参數才可以是 NULL。

傳回值

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

傳回碼/值	Description
ERROR_SUCCESS 0 (0x0)	作業成功。
ERROR_MORE_DATA 234 (0xEA)	lpbData 所指向的緩衝區不夠大，無法保存值的數據。 ClusterRegQueryValue 會將所需的大小儲存在 lpbData 的內容中。

備註

如果 lpbData 為 NULL，ClusterRegQueryValue 函式會傳回ERROR_SUCCESS，並將值數據的大小儲存在 lpbData 的內容中。這項資訊可讓呼叫端正確配置緩衝區來保存數據。

如果 lpdwValueType 設定為 REG_SZ、 REG_MULTI_SZ 或 REG_EXPAND_SZ， 則 lpbData 也會包含 NULL 終止符。

規格需求

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

另請參閱

ClusterRegOpenKey

共用方式為