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 の最初の呼び出しでは 0 にし、後続の呼び出しではインクリメントする必要があります。

値は順序付けされないため、新しい値には任意のインデックスがあります。つまり、 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)

環境変数 ("%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 が NULL の場合にのみ NULL にすることができます。

戻り値

関数は、次のいずれかの値を返します。

リターンコード/値	Description
ERROR_SUCCESS 0 (0x0)	操作に成功しました。
ERROR_NO_MORE_ITEMS 259 (0x103)	返される値はこれ以上ありません。
ERROR_MORE_DATA 234 (0xEA)	出力バッファーの 1 つ (lpszValueName または lpbData) が小さすぎて、結果のデータを保持することはできません。 lpcchValueName パラメーターと lpbData パラメーターは、必要なサイズを示します (lpcchValueName には終端の NULL が文字数に含まれていないことに注意してください)。
システムエラーコード	操作が失敗しました。

要件


サポートされている最小のクライアント	サポートなし
サポートされている最小のサーバー	Windows Server 2008 Enterprise、Windows Server 2008 Datacenter
対象プラットフォーム	Windows
ヘッダー	clusapi.h
Library	ClusAPI.lib
[DLL]	ClusAPI.dll

次の方法で共有