前のトピック: ホスト プロパティの設定: set_host_data()次のトピック: シナリオの停止: stop()


シナリオの開始: run()

run API 関数を使用すると、シナリオを実行できます。ベスト プラクティスとしては、この run API をコールする前に、add_credentials_ex API をコールしてマスタ ホストを認証します。

引数

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

名前

種類

説明

session_id

uint

create_session 関数 API のコールによって返されたセッション ID。

scenario_id

uint

開始するシナリオ ID。

sync_method

uint

同期方法。以下のいずれかのオプションを選択します。

0 - ファイル レベル同期

1 - ブロック レベル同期

2 - ボリューム レベル同期(FullSystem シナリオの場合のみ)

ignore_same_files

bool

サイズ/時間が同じファイルを無視します。

arc_upt

bool

このパラメータは、Arcserve Backup の統合シナリオのみに適用されます。シナリオが Arcserve Backup の統合シナリオ用でない場合は、このパラメータを false に設定する必要があります。

シナリオが Arcserve Backup と統合されている場合は、run API をコールする前に、add_bab_credentials API をコールします。

verification_and_run

uint

予約済み。常に 1 として定義する必要があります。

message

out string

この API が失敗したときに、その理由が含まれます。

戻り値

シナリオが正常に開始されると、true を返します。それ以外の場合、この関数は false を返し、メッセージ引数としてエラーの詳細な説明を提供します。

public bool run_example()
        {
            try
            {
                uint scenario_id = _scenario_id;
                //0:File Sync;1:Block Sync;2:Volume Sync
                uint sync_method = 0;
                bool ignore_same_files = true;
                bool arc_integrated = false;
                string message = "";
                return get_mng().run(_session_id, scenario_id, sync_method, ignore_same_files, arc_integrated, 1, out message);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }