シナリオの停止： stop()

stop API を使用すると、実行中のシナリオを停止できます。

引数

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

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

戻り値

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

例

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