ClusterRegEnumKey 関数 (clusapi.h)
開いている クラスター データベース キーのサブキーを列挙します。
構文
LONG ClusterRegEnumKey(
[in] HKEY hKey,
[in] DWORD dwIndex,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName,
[out, optional] PFILETIME lpftLastWriteTime
);
パラメーター
[in] hKey
現在開いているキーを指定する HKEY。
[in] dwIndex
列挙する次のサブキーを識別するために使用されるインデックス。 このパラメーターは、 ClusterRegEnumKey の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。
サブキーは順序付けされないため、新しいサブキーには任意のインデックスがあります。 つまり、 ClusterRegEnumKey は任意の順序でサブキーを返す可能性があります。
[out] lpszName
null 終端文字を含む、サブキーの名前を受け取るバッファーへのポインター。 関数は、完全なキー階層ではなく、サブキーの名前のみをバッファーにコピーします。
[in, out] lpcchName
文字数としての lpszName バッファーのサイズへのポインター。 入力時に、バッファーが保持できる最大文字数 (終端の NULL を含む) を指定 します。 出力時に、終了する NULL を除く、結果の名前の文字数を指定します。
[out, optional] lpftLastWriteTime
列挙されたサブキーが最後に変更された時刻へのポインター。
戻り値
関数は、次のいずれかの値を返します。
リターン コード/値 | Description |
---|---|
|
操作に成功しました。 |
|
返されるサブキーはこれ以上ありません。 |
|
lpszName が指すバッファーは、結果を保持するのに十分な大きさではありません。 lpcchName パラメーターは、終端の NULL を除き、結果の文字数を返します。 |
操作が失敗しました。 |
注釈
ClusterRegEnumKey 関数は、呼び出されるたびに 1 つのサブキーに関する情報を取得します。
ClusterRegEnumKey は、hKey が NULL に設定されている場合にアプリケーションが実行されているノード上のデータベースのルートからキーを列挙するため、ノードがクラスターの一部でない場合、ClusterRegEnumKey は失敗します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows Server 2008 Enterprise、Windows Server 2008 Datacenter |
対象プラットフォーム | Windows |
ヘッダー | clusapi.h |
Library | ClusAPI.lib |
[DLL] | ClusAPI.dll |