Ivi_GetSimulationSession
Usage
ViStatus Ivi_GetSimulationSession (ViSession vi, ViSession simulationVi);
Purpose
This function returns the simulation driver session that is currently in use by the class driver in the Simulation Vi parameter. If the simulation driver session has not been initialized, it calls the simulation driver's SimulationInit function to initialize the simulation driver.
A new session is created only the first time you invoke this function. Subsequent calls to this function return the same simulation driver session.
Call this function after calling the Ivi_LoadSimulationDriver function.
If the simulation driver does not implement the SimulationInit function, this function returns the IVI_ERROR_FUNCTION_NOT_SUPPORTED error.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from Ivi_SpecificDriverNew. The handle identifies a particular IVI session. |
| Output | ||
| Name | Type | Description |
| simulationVi | ViSession | Returns a ViSession handle that you use to identify the simulation driver session in subsequent function calls. A new session is created only the first time you invoke this function. Subsequent calls to this function return the same simulation driver session. |
Return Value
Contains the status code that the function call returns. IVI engine functions can return error and warning values from several sets of status codes. Some status codes are unique to the IVI engine. Other status codes are the same codes that VISA Library functions return. Still others are error or warning values that functions in specific instrument drivers return. Each set of status codes has its own numeric range.
Regardless of the source of the status code, 0 always indicates success, a positive value indicates a warning, and a negative value indicates an error.