Win32 API 日本語リファレンス
ホーム › Networking.Clustering › PCLUSAPI_CLUSTER_REG_ENUM_VALUE

PCLUSAPI_CLUSTER_REG_ENUM_VALUE

コールバック

シグネチャ

DWORD PCLUSAPI_CLUSTER_REG_ENUM_VALUE(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpszValueName,
    DWORD* lpcchValueName,
    DWORD* lpdwType,
    BYTE* lpData,
    DWORD* lpcbData
);

パラメーター

フィールド型説明
hKeyHKEY列挙するクラスターデータベースキーのハンドルです。
dwIndexDWORD

次に列挙する値を識別するためのインデックスです。このパラメーターは、ClusterRegEnumValue の最初の呼び出しではゼロを指定し、以降の呼び出しでは 1 ずつ増やします。

値には順序がないため、新しい値には任意のインデックスが割り当てられます。そのため、ClusterRegEnumValue が値を返す順序は不定です。

lpszValueNameLPWSTR返される値の名前を格納する、null で終わる Unicode 文字列へのポインターです。
lpcchValueNameDWORD*lpszValueName バッファーのサイズを文字数で表した値へのポインターです。入力時には、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、取得された名前の文字数が格納されます。
lpdwTypeDWORD*

値エントリの型コードへのポインターです。型コードが不要な場合は 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)

null で終わる文字列の並びで、空の文字列 (\0) で終端されます。

次に例を示します。

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

最初の \0 は 1 つ目の文字列を終端し、末尾から 2 番目の \0 は最後の文字列を終端し、最後の \0 が並び全体を終端します。この最終の終端文字も文字列の長さに含める必要があることに注意してください。

REG_NONE (0)

定義された値の型はありません。

REG_QWORD (11)

64 ビットの数値です。

REG_SZ (1)

null で終わる Unicode 文字列です。

lpDataBYTE*値エントリのデータへのポインターです。データが不要な場合、このパラメーターは NULL でもかまいません。
lpcbDataDWORD*入力時は、lpbData パラメーターが指すバッファーのバイト数へのポインターです。出力時は、操作の結果得られたバイト数へのポインターです。このパラメーターを NULL にできるのは、lpbData が NULL の場合だけです。

公式ドキュメント

開いている クラスターデータベース キーの値を列挙します。

戻り値

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

戻り値/値 説明
ERROR_SUCCESS
0 (0x0)
 操作は成功しました。
ERROR_NO_MORE_ITEMS
259 (0x103)
 返すべき値はこれ以上ありません。
ERROR_MORE_DATA
234 (0xEA)
 出力バッファーのいずれか (lpszValueName または lpbData) が、結果のデータを格納するには小さすぎます。必要なサイズは lpcchValueName パラメーターおよび lpbData パラメーターで示されます (lpcchValueName の文字数には終端の NULL が含まれない点に注意してください)。
システムエラーコード
 操作は失敗しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)