ClusterRegBatchAddCommand 関数 (clusapi.h)
クラスター レジストリ キーで実行されるバッチにコマンドを追加します。 関数の追加の呼び出しにより、バッチに追加されたコマンドが生成されます。 バッチは ClusterRegCreateBatch 関数によって作成され、 ClusterRegCloseBatch 関数によって実行されるか無視されます。
構文
LONG ClusterRegBatchAddCommand(
[in] HREGBATCH hRegBatch,
[in] CLUSTER_REG_COMMAND dwCommand,
[in, optional] LPCWSTR wzName,
[in] DWORD dwOptions,
[in, optional] VOID const *lpData,
[in] DWORD cbData
);
パラメーター
[in] hRegBatch
コマンドを追加するバッチのハンドル。
[in] dwCommand
CLUSTER_REG_COMMAND列挙から取得される、この API でサポートされるコマンド。 使用できるコマンドは次のとおりです。
CLUSREG_SET_VALUE (1)
ClusterRegCreateBatch 関数に渡されたキーに対して、最後に実行されたCLUSREG_CREATE_KEYコマンドまたは (指定されていない場合) に対して相対的な値を設定します。
CLUSREG_CREATE_KEY (2)
指定したクラスター レジストリ キーが存在しない場合は作成するか、既存のクラスター レジストリ キーを開きます。
CLUSREG_DELETE_KEY (3)
すべての値と入れ子になったサブキーを含むキーを削除します。 値を操作するコマンドは、 CLUSREG_CREATE_KEY が追加されるまで CLUSREG_DELETE_KEY に従う必要はありません。
CLUSREG_DELETE_VALUE (4)
ClusterRegCreateBatch 関数に渡されたキーに対して、最後に実行された CLUSREG_CREATE_KEY コマンドまたは (指定されていない場合) に対する相対値を削除します。
[in, optional] wzName
dwCommand パラメーターによって発行されたコマンドに対する相対値またはキーの名前。
[in] dwOptions
dwCommand が CLUSREG_SET_VALUE コマンドを受け取る場合、このパラメーターは標準のレジストリ値の型のいずれかを受け取ります。 そうでない場合、 dwCommand は 0 に設定されます。
[in, optional] lpData
dwCommand によって発行されたコマンドに関連するデータへのポインター。 このパラメーターの値は、CLUSREG_SET_VALUE コマンド以外のすべての場合は NULL です。
[in] cbData
dwCommand によって発行されたコマンドに関連するデータのカウント (バイト単位)。 このパラメーターの値は、 CLUSREG_SET_VALUE コマンド以外のすべての場合は 0 です。
戻り値
関数は、次のいずれかの システム エラー コードを返します。
| リターン コード/値 | Description |
|---|---|
|
操作に成功しました。 |
|
関数が正しくありません。 この値は、 dwCommand が前のセクションで説明したコマンド以外のコマンドを受け取った場合に返されます。 |
|
ハンドルが無効です。 hRegBatch パラメーターが NULL の場合、この値が返されます。 |
|
この操作を実行するには、使用できる領域が十分ではありません。 |
|
システムに接続されたデバイスが動作していません。 |
|
パラメーターが正しくありません。 バッチがコマンドの実行を試みるクラスター レジストリ キーが現在のキーではない場合、この値が返されます。 |
注釈
PCLUSTER_REG_BATCH_ADD_COMMAND型は、この関数へのポインターを定義します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows Server 2008 Datacenter、Windows Server 2008 Enterprise |
| 対象プラットフォーム | Windows |
| ヘッダー | clusapi.h |
| Library | ClusAPI.lib |
| [DLL] | ClusAPI.dll |