ホーム › Networking.Clustering › PCLUSAPI_CLUSTER_REG_ENUM_KEY

PCLUSAPI_CLUSTER_REG_ENUM_KEY

コールバック

シグネチャ

INT PCLUSAPI_CLUSTER_REG_ENUM_KEY(
    HKEY hKey,
    DWORD dwIndex,
    LPWSTR lpszName,
    DWORD* lpcchName,
    FILETIME* lpftLastWriteTime
);

パラメーター

フィールド	型	説明
hKey	HKEY	現在開いているキーを指定する HKEY です。
dwIndex	DWORD	次に列挙するサブキーを識別するために使用するインデックスです。このパラメーターは ClusterRegEnumKey の最初の呼び出しではゼロを指定し、以降の呼び出しでは 1 ずつ増やします。サブキーには順序がないため、新しいサブキーには任意のインデックスが割り当てられます。つまり ClusterRegEnumKey はサブキーを任意の順序で返す可能性があります。
lpszName	LPWSTR	サブキーの名前を null 終端文字を含めて受け取るバッファーへのポインターです。この関数は、キー階層全体ではなくサブキーの名前だけをバッファーにコピーします。
lpcchName	DWORD*	lpszName バッファーのサイズを文字数で示す値へのポインターです。入力時には、終端の NULL を含めてバッファーが保持できる最大文字数を指定します。出力時には、終端の NULL を除いた、取得された名前の文字数が格納されます。
lpftLastWriteTime	FILETIME*	列挙されたサブキーが最後に変更された時刻へのポインターです。

公式ドキュメント

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

戻り値

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

リターンコード/値	説明
ERROR_SUCCESS 0	操作は成功しました。
ERROR_NO_MORE_ITEMS 259 (0x103)	返すべきサブキーはこれ以上ありません。
ERROR_MORE_DATA 234 (0xEA)	lpszName が指すバッファーは、結果を格納するには十分な大きさがありません。 lpcchName パラメーターには、終端の NULL を除いた結果の文字数が返されます。
システムエラーコード	操作は失敗しました。

解説(Remarks)

ClusterRegEnumKey 関数は、呼び出されるたびに 1 つのサブキーに関する情報を取得します。

hKey が NULL に設定されている場合、ClusterRegEnumKey はアプリケーションが実行されているノード上のデータベースのルートからキーを列挙するため、そのノードがクラスターの一部でないときは ClusterRegEnumKey は失敗します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)