Initializes a DB Simulation. Opens the datatable using DbConnection and datatablename, results will be written to temp DataTable and then updated in the Database.
Namespace: WaterSimDCDCAssembly: WaterSimDCDC_API (in WaterSimDCDC_API.dll) Version: 5.0.0.10 (5.0.0.10)
Syntax
C# |
---|
public bool Simulation_Initialize( string aDataTablename, string Scenario_Name ) |
Visual Basic |
---|
Public Function Simulation_Initialize ( _ aDataTablename As String, _ Scenario_Name As String _ ) As Boolean |
Parameters
- aDataTablename
- Type: System..::..String
- Scenario_Name
- Type: System..::..String
the name of the scenario to label the output
Return Value
true if datatable was opended and simulation initialized, false otherwise, check isError and GetErrorMessage()Remarks
The scenario name is important becuase it can be used to retrieve the Simulation inputs from the datatable later.
Exceptions
Exception | Condition |
---|---|
WaterSim_DB_Exception | if data base is not open |