Tema anterior: Creación de escenarios: create_scenario_ex()Tema siguiente: Adición de directorios raíz: add_root_dir()


Establecimiento de directorios raíz: set_root_dir()

La función de API set_root_dir() permite editar la ruta del directorio raíz.

Argumentos

La función de API set_root_dir 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 de función create_session.

scenario_id

uint

El ID del escenario.

host_index

uint

El índice del host que desea establecer.

root_dir_index

uint

El índice del directorio raíz, empezando desde cero; si se tienen dos directorios raíz, los índices son 0 y 1.

root_dir

cadena

El nombre de la carpeta.

Nota: Este argumento es necesario solamente para los escenarios de todo el sistema. Sin embargo, esta función de API no admite actualmente el establecimiento de directorios raíz para escenarios de todo el sistema.

Valores de retorno

Esta función devuelve un valor verdadero cuando la llamada de API se completa correctamente. De lo contrario, esta función devuelve un valor falso.

Nota: La API create_scenario_ex crea solamente un esqueleto del escenario. Se puede llamar esta API para establecer el directorio raíz.

Ejemplo

uint master_host_index = 1;
get_mng().set_root_dir(_session_id, scenario_id, master_host_index, 0, "E:/test");