niScope_init
- Updated2023-02-21
- 3 minute(s) read
C Function Prototype
ViStatus niScope_init (ViRsrc resourceName, ViBoolean IDQuery, ViBoolean resetDevice, ViSession* vi);
Purpose
Performs the following initialization actions:
- Creates a new IVI instrument driver session
- Opens a session to the specific driver using the interface and address (devices) you specify in the resourceName
- Queries each instrument ID and checks that it is valid for NI-SCOPE
- Resets the digitizer(s) to a known state, if resetDevice is set to VI_TRUE
- Sends initialization commands to set the instrument(s) to the state necessary for the operation of the instrument driver
- Returns an instrument handle that you use to identify the instrument(s) in all subsequent instrument driver function calls
Related topics:
Parameters
| Input | ||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||
| resourceName | ViRsrc | Specifies the device name assigned by Measurement & Automation Explorer (MAX) to an NI-SCOPE instrument, for example, PXI1Slot3, where PXI1Slot3 is an instrument resource name. This parameter accepts a comma-delimited list of strings in the form PXI1Slot3,PXI1Slot4, where PXI1Slot3 is one instrument resource name and PXI1Slot4 is another.
resourceName Examples
For NI-DAQmx devices, the syntax is just the device name specified in MAX, as shown in Example 1. Typical default names for NI-DAQmx devices in MAX are Dev1 or PXI1Slot1. You can rename an NI-DAQmx device by right-clicking on the name in MAX and entering a new name. An alternate syntax for NI-DAQmx devices consists of DAQ::NI-DAQmx device name, as shown in Example 2. This naming convention allows for the use of an NI-DAQmx device in an application that was originally designed for a Traditional NI-DAQ device. For example, if the application expects DAQ::1, you can rename the NI-DAQmx device to 1 in MAX and pass in DAQ::1 for the resource name, as shown in Example 3. You can also pass in the name of an IVI logical name or an IVI virtual name configured with the IVI Configuration utility, as shown in Example 4. A logical name identifies a particular virtual instrument. A virtual name identifies a specific device and specifies the initial settings for the session.
|
||||||||||||||||||||||||||
| idQuery | ViBoolean | Specify whether to perform an ID query.
When you set this parameter to VI_TRUE, NI-SCOPE verifies that the device you initialize is a type that it supports. When you set this parameter to VI_FALSE, the function initializes the device without performing an ID query. Defined Values VI_TRUE—Perform ID query Default Value: VI_TRUE |
||||||||||||||||||||||||||
| resetDevice | ViBoolean | Specify whether to reset the device during the initialization process.
Defined Values VI_TRUE—Reset device Default Value: VI_TRUE |
||||||||||||||||||||||||||
| Output | ||||||||||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||||||||||
| vi | ViSession* | Returns a session handle that you can use to identify the device in all subsequent NI-SCOPE function calls. | ||||||||||||||||||||||||||
Return Value
| Name | Type | Description | ||||||||
| Status | ViStatus | Reports the status of this operation. To obtain a text description of the status code,
call
niScope_GetErrorMessage.
To obtain additional information concerning the error
condition, use niScope_GetError
and
niScope_ClearError.
The general meaning of the status code is as follows:
|