Adding Rewind Bookmarks: set_rewind

SOAP APIs › Scenario Management APIs › Adding Rewind Bookmarks: set_rewind_bookmark()

Adding Rewind Bookmarks: set_rewind_bookmark()

The set_rewind_bookmark API function lets you set bookmarks for scenarios.

Arguments

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

Name	Type	Description
scenario_id	string	The scenario ID for which you want to set bookmarks.
host_index	uint	Always = 1.
bookmark_msg	string	The bookmark name.
why_not_reason	out string	Contains the reason for failure when this API fails.

Return Values

The return type is Boolean. When the return value is true, the API completed successfully. When the return value is false, the API did not complete successfully. If the return value is false, review the message to determine the reason the API failed.

Example

public bool set_rewind_bookmark_example()
        {
            try
            {
                string scenario_id = _scenario_id.ToString();
                uint host_index = 1;
                string why_not_reason = "";
                string bookmark_msg = "test bookmark";
                return get_mng().set_rewind_bookmark(scenario_id, host_index, bookmark_msg, out why_not_reason);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }