ConfigureList Method
- Updated2023-02-21
- 3 minute(s) read
Configures the SwitchScan.List and SwitchScan.Mode used for scanning.
Refer to Switch Device Help to determine if the switch module supports scanning.
The SwitchScan.List is comprised of a list of channel connections separated by semicolons. For example, the following scan list will scan the first three channels of a multiplexer:
com0->ch0; com0->ch1; com0->ch2;
Refer to SwitchScan.List for more information on scan list syntax.
To see the status of the scan, call either SwitchScan.IsScanning or SwitchScan.WaitForScanComplete. Use the SwitchScan.ConfigureTrigger method to configure the scan trigger. Use the SwitchScan.Initiate method to start the scan.
Namespace:
NationalInstruments.ModularInstruments.NISwitch
Assembly:
NationalInstruments.ModularInstruments.NISwitch.Fx40 (in NationalInstruments.ModularInstruments.NISwitch.Fx40.dll) Version: 19.0.0.49152 (19.0.0.49152)| Visual Basic (Declaration) |
|---|
Public Sub ConfigureList ( _ scanList As String, _ scanMode As SwitchScanMode _ ) |
| C# |
|---|
public void ConfigureList( string scanList, SwitchScanMode scanMode ) |
Parameters
- scanList
- Type: System..::.StringThe scan list to use. NI-SWITCH uses this value to set the SwitchScan.List attribute.
- scanMode
- Specifies how the switch module breaks existing connections when scanning. The driver uses this value to set the SwitchScan.Mode attribute. Refer to NISwitch.SwitchScanMode for more information. The default value is SwitchScanMode.BreakBeforeMake.
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | The ConfigureList method was accessed after the associated NISwitch.NISwitch object was disposed. |