ni-rfsg-dotnet-api-ref_doc

Content Type
Programming Language
Current manual
Table of Contents

RfsgDriverUtility.ResetWithOptions Method

RfsgDriverUtility.ResetWithOptions Method

RfsgDriverUtilityResetWithOptions Method

Resets all properties to default values and specifies steps to omit during the reset process, such as signal routes.

Namespace:  NationalInstruments.ModularInstruments.NIRfsg
Assembly:  NationalInstruments.ModularInstruments.NIRfsg.Fx40 (in NationalInstruments.ModularInstruments.NIRfsg.Fx40.dll) Version: 2022

Syntax

public void ResetWithOptions(
	RfsgResetStepsToOmit stepsToOmit
)
Public Sub ResetWithOptions ( 
	stepsToOmit As RfsgResetStepsToOmit
)

Parameters

stepsToOmit
Type: NationalInstruments.ModularInstruments.NIRfsgRfsgResetStepsToOmit
Specifies a list of steps to skip during the reset process.

Exceptions

ExceptionCondition
ObjectDisposedException The ResetWithOptions(RfsgResetStepsToOmit) method was accessed after the associated NIRfsg object was disposed.

Remarks

By default, this method exhibits the same behavior as ResetAttribute(PropertyInfo).

You can specify steps to omit using the steps to omit parameter. For example, if you specify Routes for the steps to omit parameter, this method 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 the PXIe-5644/5645/5646 and PXIe-5820/5830/5831/5832/5840 that are in use by other NI-RFSA or NI-RFSG sessions, NI recommends using this method instead of ResetAttribute(PropertyInfo) with RfsgResetStepsToOmit set to Routes.

See Also

Was this information helpful?