Detención de escenarios: stop()

API de SOAP › API de gestión de escenarios › Detención de escenarios: stop()

Detención de escenarios: stop()

La función de API de detención permite detener los escenarios en ejecución.

Argumentos

La función de API de detención incluye los argumentos descritos en la tabla siguiente:

Nombre	Tipo	Descripción
session_id	uint	El ID de sesión que se ha devuelto llamando a la API create_session.
scenario_id	uint	El ID de escenario que debe detenerse.
execute_sync	bool	Regula si debe llamarse a esta API sincrónica o asincrónicamente. Cuando se establece este argumento como verdadero, la función de API no devolverá ningún valor hasta que el escenario se detenga. De lo contrario, la función devuelve un valor inmediatamente.
why_not_reason	out string	Contiene una descripción detallada del error cuando se produce un error en esta API.

Valores de retorno

El tipo de valor de retorno es booleano. Cuando el valor de retorno es verdadero, la API finalizará correctamente. Cuando el valor de retorno es falso, la API no finaliza correctamente. Si el valor de retorno es falso, revise el mensaje devuelto en el argumento why_not_reason para determinar la causa de error en la API.

Ejemplo

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;
        }