Ets_Pj_Scenarios_Manage()
Note: Requires OPNET Development Kit
Abstract
Opens a scenario management dialog box with custom buttons and columns.
Syntax
Ets_Pj_Scenarios_Manage (button_definition_lptr, callback, num_columns, column_names [], options, client_state_ptr)
| Argument | Type | Description |
|---|---|---|
button_definition_lptr |
PrgT_List * |
List of custom button definitions (see button_definition_lptr). |
callback |
EtsT_Pj_Scenarios_Manage_Event_Callback |
Callback to handle responses to user inputs. |
num_columns |
int |
Number of columns to include in the dialog box. |
column_names [] |
char * |
Array of names for the columns. |
options |
int |
Standard system buttons to be included in the dialog box (see options). |
client_state_ptr |
void * |
User-specified state information to be passed to the callback. |
Return Type
EtsT_Pj_Scenarios_Manage_Handle
State information used to manage scenarios in the current project.
Header
ets_api_pj.h
Details
This function creates a scenario management state and associated Manage Scenarios dialog box. The dialog box is blocking; no other operations can be performed while it is open. Use Ets_Pj_Scenarios_Manage_Dbox_Get() to get a reference to the Manage Scenarios dialog box created by this function.
You can use this function to display a customized dialog for managing scenarios. To do so, you would typically edit the .ets files for your application to replace the standard Scenarios > Manage Scenarios menu item with a custom one that invokes this function.
As an alternative to creating a custom dialog box for managing scenarios, you can redefine the functionality of the standard Manage Scenarios dialog box; see Ets_Pj_Scenarios_Manage_Event_Callback_Register() for details.
button_definition_lptr
button_definition_lptr is a list of custom buttons to be included in the dialog box. Each element of the list is a button definition created with Ets_Pj_Scenarios_Manage_Button_Def_Create().
options
options must be ETSC_PJ_SCENARIOS_MANAGE_OPT_NONE or an OR’ed combination of one or more of the following constants:
- ETSC_PJ_SCENARIOS_MANAGE_OPT_DISCARD_BUTTON
- ETSC_PJ_SCENARIOS_MANAGE_OPT_COLLECT_BUTTON
- ETSC_PJ_SCENARIOS_MANAGE_OPT_COLLECT_ALL_BUTTON
- ETSC_PJ_SCENARIOS_MANAGE_OPT_DELETE_BUTTON
The prototype for callback_proc is given in EtsT_Pj_Scenarios_Manage_Event_Callback.