C_GetSimulationTimeToGo

Call C_GetSimulationTimeToGo to obtain an estimate of the real time remaining before the active simulation is complete.

double C_GetSimulationTimeToGo(

TOrcFxAPIHandle ModelHandle,

int *lpStatus

);

Parameters

ModelHandle (IN)

The handle of the model.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

Return Value

The real time remaining (in seconds) before the active simulation is complete.

If no simulation is currently running then OrcinaUndefinedReal() is returned. Likewise, if the simulation has not been running long enough to make a reasonable estimate of the time to go then OrcinaUndefinedReal() is returned.

See also

C_RunSimulation, C_RunSimulation2.