Admin Production ni-theme
Current Publication

Ivi_SimulationDriverNew

IVI Compliance Package

Ivi_SimulationDriverNew

Usage

ViStatus Ivi_SimulationDriverNew (ViChar logicalName[], ViSession vi);

Purpose

This function performs the following initialization actions:

  • Creates a new IVI simulation driver session to a simulation driver.
  • Returns a ViSession handle that you use in subsequent function calls to identify the session.

This function creates a new session each time you invoke it. The session can be used in multiple execution threads. You can use the Ivi_LockSession and Ivi_UnlockSession functions to protect sections of code that require exclusive access to the session.

Note Note  IVI simulation drivers are initialized, loaded, and used by IVI class drivers when the user configures a Driver Session in the IVI configuration store file to simulate with one of the class simulation drivers instead of specific simulation. Refer to the IVI Driver Help Introduction section of the NI IVI Driver Help for more information about simulation drivers.

Parameters

Input
Name Type Description
logicalName ViChar[] This parameter specifies the logical name in the IVI Configuration Store file that is used to initialize the class driver.

The IVI Engine uses the driver session referenced by the logical name to build a list of virtual repeated capability names defined by the driver session.
Output
Name Type Description
vi ViSession Returns a ViSession handle that you use to identify the simulation driver session in subsequent function calls.

This function creates a new session each time you invoke it. The session can be used in multiple execution threads. You can use functions Ivi_LockSession and Ivi_UnlockSession to protect sections of code that require exclusive access to the 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.

Related Topic

IVI Status Codes