Adding Root Directories: add_root

SOAP APIs › Scenario Management APIs › Adding Root Directories: add_root_dir()

Adding Root Directories: add_root_dir()

The add_root_dir API function lets you add a new root directory for the scenario.

Arguments

The add_root_dir API function includes the arguments described in the following table:

Name	Type	Description
session_id	uint	he session ID that was returned by calling the create_session function API.
scenario_data	ref string	The data for the scenario. After calling this API, the argument contains the updated scenario data.
root_directories	string	The folder name.
new_root_dir_index	out uint	The index of the newly created root directory.

Return Values

This function returns a value of true when the API call completes successfully. Otherwise, this function returns a value of false.

Example: Adding a root directory

String scenario_data = get_mng().get_scenario_data(_session_id, scenario_id);

//add root directory
get_mng().add_root_dir(_session_id, ref scenario_data, "c:/test", out new_root_dir_id);