Eliminación de escenarios: remove

API de SOAP › API de gestión de escenarios › Eliminación de escenarios: remove_scenario()

Eliminación de escenarios: remove_scenario()

La función de API remove_scenario permite eliminar escenarios del servicio de control.

Argumentos

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

Name	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 escenario ID que ejecutará.
arc_upd	bool	Este parámetro se aplica solamente a escenarios integrados de Arcserve Backup.
why_not-reason	out string	Contiene el motivo del error cuando se produce un error en esta API.

Valor 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 para determinar el motivo por el cual la API es errónea.

Ejemplo

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