niFgen_InitExtCal
- Updated2023-02-21
- 3 minute(s) read
ViStatus niFgen_InitExtCal (ViRsrc resourceName, ViConstString password, ViSession* vi);
Purpose
Creates and initializes a special NI-FGEN external calibration session. The ViSession returned is an NI-FGEN session that can be used to configure the device using normal attributes and functions. However, flags have been set that allow you to program an external calibration procedure using the special calibration attributes and functions. The NI 5401/5404/5411/5431 have different calibration functions. Refer to the calibration procedure for the signal generator for more information.
Parameters
| Input | |||||||||||||||||||||||||
| Name | Type | Description | |||||||||||||||||||||||
| resourceName | ViRsrc | Specifies the resource name of the device to initialize.
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 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. If you use the DAQ::n syntax and an NI-DAQmx device name already exists with that same name, the NI-DAQmx device is matched first. 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.
|
|||||||||||||||||||||||
| password | ViConstString | The calibration password required to open an external calibration session to the device. | |||||||||||||||||||||||
| Output | |||||||||||||||||||||||||
| Name | Type | Description | |||||||||||||||||||||||
| vi | ViSession | Returns a session handle that you can use to identify the device in all subsequent NI-FGEN function calls. | |||||||||||||||||||||||
Return Value
| Name | Type | Description | ||||||||
| status | ViStatus | Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|