DigitalSourceWaveforms.CreateFromFile Method
- Updated2023-11-24
- 1 minute(s) read
DigitalSourceWaveformsCreateFromFile Method
Creates the source waveform settings used to source waveforms with configuration information contained in a .tdms file.
Namespace: NationalInstruments.ModularInstruments.NIDigital
Assembly: NationalInstruments.ModularInstruments.NIDigital.Fx40 (in NationalInstruments.ModularInstruments.NIDigital.Fx40.dll) Version: 2021
Syntax
public void CreateFromFile( string waveformName, string waveformFilePath, bool writeWaveformData )
Public Sub CreateFromFile ( waveformName As String, waveformFilePath As String, writeWaveformData As Boolean )
Parameters
- waveformName
- Type: SystemString
Specifies the waveform name to use from the file. You must specify a waveform name if the file contains multiple waveforms. Use the waveformName with the source_start opcode in your pattern. - waveformFilePath
- Type: SystemString
Specifies the absolute file path to the source waveform file (.tdms). - writeWaveformData
- Type: SystemBoolean
Writes waveform data to source memory if and the waveform data is in the file.
Exceptions
| Exception | Condition |
|---|---|
| IviCDriverException | The NI-Digital Pattern Driver returned an error. |
| ArgumentException | The waveform name specified by waveformName does not exist. |
| FileNotFoundException | The file was not found at the specified waveformFilePath. |
Remarks
For more information, refer to Opcodes and Source Waveform Configurations
in the Digital Pattern Help.