ClusterRegQueryValue 関数 (clusapi.h)

[アーティクル]
08/22/2023

開いているクラスターデータベースキーの値に関連付けられている名前、型、およびデータコンポーネントを返します。

構文

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)

環境変数への展開されていない参照 ("%PATH%" など) を含む null で終わる Unicode 文字列。

REG_MULTI_SZ (6)

空の文字列 (\0) で終わる null で終わる文字列のシーケンス。

以下に例を示します。

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

最初の \0 は最初の文字列を終了し、最後の \0 の 2 番目の文字列は最後の文字列を終了し、最後の \0 はシーケンスを終了します。最後のターミネータは文字列の長さに組み込む必要があることに注意してください。

REG_NONE (0)

値型が定義されていません。

REG_QWORD (11)

64 ビット番号。

REG_SZ (1)

NULL で終わる Unicode 文字列。

[out, optional] lpData

値のデータへのポインター。データが不要な場合、このパラメーターは NULL にすることができます。

[in, out, optional] lpcbData

入力時に、 lpbData パラメーターによって指されるバッファー内のバイト数へのポインター。出力時に、値のデータ内のバイト数へのポインター。これは、呼び出し元が有効なポインターを渡した場合に lpbData のコンテンツに配置されます。

lpbData パラメーターは、lpbData も NULL の場合にのみ 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
Library	ClusAPI.lib
[DLL]	ClusAPI.dll

こちらもご覧ください

ClusterRegOpenKey

次の方法で共有