NI-Digital Pattern Driver .NET Class Library

Table of Contents

DigitalCaptureWaveforms.CreateSerial Method (String, String, UInt32, BitOrder)

  • Updated2023-11-24
  • 2 minute(s) read
DigitalCaptureWaveforms.CreateSerial Method (String, String, UInt32, BitOrder)

DigitalCaptureWaveformsCreateSerial Method (String, String, UInt32, BitOrder)

Creates the capture waveform settings for serial acquisition using a comma-delimited string of pins or channels.

Namespace:  NationalInstruments.ModularInstruments.NIDigital
Assembly:  NationalInstruments.ModularInstruments.NIDigital.Fx40 (in NationalInstruments.ModularInstruments.NIDigital.Fx40.dll) Version: 2021

Syntax

public void CreateSerial(
	string pinSetString,
	string waveformName,
	uint sampleWidth,
	BitOrder bitOrder
)
Public Sub CreateSerial ( 
	pinSetString As String,
	waveformName As String,
	sampleWidth As UInteger,
	bitOrder As BitOrder
)

Parameters

pinSetString
Type: SystemString
The set of pins or channels for which to create the waveform.
waveformName
Type: SystemString
Specifies the waveform name to use. Use the waveformName with the capture_start opcode in your pattern.
sampleWidth
Type: SystemUInt32
The width in bits of each serial sample. Valid values are between 1 and 32.
bitOrder
Type: NationalInstruments.ModularInstruments.NIDigitalBitOrder
The order in which to shift the bits. This can be most significant bit first or least significant bit first.

Exceptions

ExceptionCondition
SelectorNameExceptionThe value for pinSetString contains a pin or pin group name not loaded in the pin map.
InvalidOperationExceptionThe value for pinSetString contains a system pin.
ArgumentException
  1. The value for waveformName is an empty string or contains an invalid character.
  2. The value for sampleWidth is invalid.
  3. The value for bitOrder is invalid.
OutOfRangeExceptionThe number of waveforms in capture memory exceeds the maximum number of waveforms allowed.

Remarks

The number of waveforms is limited to 512.

Settings apply across all sites if multiple sites are configured in the pin map. You cannot reconfigure settings after waveforms are created.

See Also

Log in to get a better experience