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

PCLUSTER_REG_BATCH_ADD_COMMAND

コールバック

シグネチャ

INT PCLUSTER_REG_BATCH_ADD_COMMAND(
    HREGBATCH hRegBatch,
    CLUSTER_REG_COMMAND dwCommand,
    LPWSTR wzName,
    DWORD dwOptions,
    void* lpData,
    DWORD cbData
);

パラメーター

フィールド型説明
hRegBatchHREGBATCHコマンドの追加先となるバッチのハンドルです。
dwCommandCLUSTER_REG_COMMAND

CLUSTER_REG_COMMAND 列挙型から取得した、 この API がサポートするコマンドです。指定できるコマンドは次のとおりです。

CLUSREG_SET_VALUE (1)

最後に実行された CLUSREG_CREATE_KEY コマンドを基準として、または (指定されていない場合は) ClusterRegCreateBatch 関数に渡されたキーを基準として、値を設定します。

CLUSREG_CREATE_KEY (2)

指定されたクラスターレジストリキーが存在しない場合は作成し、存在する場合は既存のキーを開きます。

CLUSREG_DELETE_KEY (3)

キーを、そのすべての値および入れ子になったサブキーとともに削除します。CLUSREG_CREATE_KEY が追加されるまで、 CLUSREG_DELETE_KEY の後に値を操作するコマンドを続けることはできません。

CLUSREG_DELETE_VALUE (4)

最後に実行された CLUSREG_CREATE_KEY コマンドを基準として、または (指定されていない場合は) ClusterRegCreateBatch 関数に渡されたキーを基準として、値を削除します。

wzNameLPWSTRdwCommand パラメーターで指定したコマンドを基準とした、値またはキーの名前です。
dwOptionsDWORDdwCommand が CLUSREG_SET_VALUE コマンドを受け取る場合、 このパラメーターには標準の レジストリ値の型 のいずれかを指定します。そうでない場合、 dwCommand は 0 に設定されます。
lpDatavoid*dwCommand で指定したコマンドに対応するデータへのポインターです。このパラメーターの値は、 CLUSREG_SET_VALUE コマンド以外のすべてのコマンドで NULL です。
cbDataDWORDdwCommand で指定したコマンドに対応するデータのサイズ (バイト単位) です。 このパラメーターの値は、CLUSREG_SET_VALUE コマンド以外のすべてのコマンドで 0 です。

公式ドキュメント

クラスターレジストリキーに対して実行されるバッチにコマンドを追加します。この関数をさらに呼び出すと、 バッチにコマンドが追加されていきます。バッチは ClusterRegCreateBatch 関数によって作成され、 ClusterRegCloseBatch 関数によって実行されるか、または無視されます。

戻り値

この関数は、次のいずれかの システムエラーコード を返します。

戻り値/値 説明
ERROR_SUCCESS
0
 操作は成功しました。
ERROR_INVALID_FUNCTION
1
 関数が正しくありません。この値は、dwCommand に前述のセクションで説明したコマンド以外のコマンドを 指定した場合に返されます。
ERROR_INVALID_HANDLE
6
 ハンドルが無効です。この値は、hRegBatch パラメーターが NULL の場合に返されます。
ERROR_OUTOFMEMORY
14 (0xE)
 この操作を完了するのに十分な記憶域がありません。
ERROR_GEN_FAILURE
31 (0x1F)
 システムに接続されているデバイスが機能していません。
ERROR_INVALID_PARAMETER
87 (0x57)
 パラメーターが正しくありません。この値は、バッチがコマンドを実行しようとしているクラスターレジストリキーが 現在のキーではない場合に返されます。

解説(Remarks)

PCLUSTER_REG_BATCH_ADD_COMMAND 型は、この関数へのポインターを定義します。

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