C_PauseSimulation

Call C_PauseSimulation to pause a simulation whilst it is running.

void C_PauseSimulation(

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.

Remarks

This function can only be called when the model is in msRunningSimulation state. The model state can be obtained by calling C_GetModelState.

The model will only be in this state while calls to C_RunSimulation or C_RunSimulation2 are being executed. Because of this the natural time to call C_PauseSimulation is from the DynamicsProgressHandlerProc which is called repeatedly during the execution of C_RunSimulation or C_RunSimulation2.

See also

C_GetModelState, C_GetSimulationComplete, C_RunSimulation, C_RunSimulation2.