niRFSA_ResetWithOptions
- Updated2024-05-08
- 2 minute(s) read
niRFSA_ResetWithOptions
ViStatus niRFSA_ResetWithOptions(ViSession vi, ViInt64 stepsToOmit);
Purpose
Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.
For the PXI-5600, this function does not reset the PXI Clock signal that is driven by devices installed in the Star Trigger Controller Slot, also known as the System Timing Slot.
By default, this function resets all properties to their default values, deletes all de-embedding tables, aborts generation, clears all routes, and resets session properties to initial values. You can specify steps to omit using the steps to omit parameter. For example, if you specify NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES for the stepsToOmit parameter, this function does not release signal routes during the reset process.
When routes of signals between two devices are released, they are released regardless of which device created the route.
To avoid resetting routes on PXIe-5820/5830/5831/5832/5840/5841/5842 that are in use by NI-RFSG sessions, NI recommends using this function instead of niRFSA_Reset, with stepsToOmit set to NIRFSA_VAL_RESET_WITH_OPTIONS_ROUTES.
Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5693/5694, PXIe-5820/5830/5831/5832/5840/5841/5842
Related Topics
Parameters
| Input | ||||||||||||
| Name | Type | Description | ||||||||||
| vi | ViSession | Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function. | ||||||||||
| stepsToOmit | ViUInt64 | Specifies a list of steps to skip during the reset process. The default value is NIRFSA_VAL_RESET_WITH_OPTIONS_NONE, which specifies that no step is omitted during reset.
|
||||||||||
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. Examine the status code from each call to an NI-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||