シナリオの削除： remove

SOAP API › シナリオ管理 API › シナリオの削除： remove_scenario()

シナリオの削除： remove_scenario()

remove_scenario API 関数を使用すると、コントロールサービスからシナリオを削除できます。

引数

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

名前	タイプ	説明
session_id	uint	create_session API をコールすることで返されたセッション ID。
scenario_id	uint	実行されるシナリオ ID。
arc_upd	bool	このパラメータは、Arcserve Backup の統合シナリオのみに適用されます。
why_not-reason	out string	この API が失敗する時に、その失敗の理由が含まれます。

戻り値

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

例

public bool remove_scenario_example()
        {
            try
            {
                uint scenario_id = _scenario_id;
                bool arc_integrated = false;
                string why_not_reason = "";
                return get_mng().remove_scenario(_session_id, scenario_id, arc_integrated, out why_not_reason);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }