データレプリケーションの一時停止： suspend

SOAP API › シナリオ管理 API › データレプリケーションの一時停止： suspend_replication()

データレプリケーションの一時停止： suspend_replication()

suspend_replication API 関数を使用すると、ホストのレプリケーション操作を一時停止できます。

引数

suspend_replication API 関数には、以下のテーブルに記述されている引数が含まれています。

名前	タイプ	説明
session_id	uint	create_session API をコールすることで返されたセッション ID。
scenario_id	uint	一時停止するシナリオ ID。
replica_index	uint	シナリオ内のレプリカホストインデックス。通常、レプリカインデックスの値は 2 です。
execute_sync	bool	この API を同期または非同期でコールするかどうかを指定します。この引数を true に設定した場合、シナリオが完了するまで API 関数は値を返しません。それ以外の場合、この関数は値を即座に返します。
message	out string	この API が失敗する時に、その失敗の理由が含まれます。

戻り値

戻り値のタイプはブールです。戻り値が true の場合、API は正常に完了しています。戻り値が false の場合、API は正常に完了しませんでした。戻り値が false の場合は、メッセージを確認して API が失敗した理由を特定してください。

例

public bool suspend_replication_example()
        {
            try
            {
                uint scenario_id = _scenario_id;
                string message = "";
                bool execute_sync = true;
                uint replica_index = 2;
                return get_mng().suspend_replication(_session_id, scenario_id, replica_index, execute_sync, out message);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }

データ レプリケーションの一時停止： suspend_replication()

データレプリケーションの一時停止： suspend_replication()