NI-Digital Pattern Driver .NET Class Library

Table of Contents

DigitalPatternControl.BurstPattern Method (String, String, Boolean, Boolean, TimeSpan)

  • Updated2023-11-24
  • 2 minute(s) read
DigitalPatternControl.BurstPattern Method (String, String, Boolean, Boolean, TimeSpan)

DigitalPatternControlBurstPattern Method (String, String, Boolean, Boolean, TimeSpan)

Starts a pattern burst and optionally blocks program execution until the pattern burst is complete.

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

Syntax

public void BurstPattern(
	string siteList,
	string startLabel,
	bool selectDigitalFunction,
	bool waitUntilDone,
	TimeSpan maxTime
)
Public Sub BurstPattern ( 
	siteList As String,
	startLabel As String,
	selectDigitalFunction As Boolean,
	waitUntilDone As Boolean,
	maxTime As TimeSpan
)

Parameters

siteList
Type: SystemString
The sites on which to burst the pattern as a comma-delimited list of strings of the form siteN, where N is the site number. If you specify an empty string, the pattern is burst on all sites.
startLabel
Type: SystemString
The pattern name or exported pattern label from which to start bursting the pattern.
selectDigitalFunction
Type: SystemBoolean
If , sets the SelectedFunction of the pins to Digital.
waitUntilDone
Type: SystemBoolean
If , waits until the pattern burst is completed; otherwise, initiates a pattern burst and returns.
maxTime
Type: SystemTimeSpan
The maximum time interval allowed for the pattern burst to complete.

Exceptions

ExceptionCondition
IviCDriverExceptionThe NI-Digital Pattern Driver returned an error.
InvalidOperationExceptionBurstPattern(String, String, Boolean, Boolean, TimeSpan) is called before loading a pattern.
SelectorNameExceptionThe value for siteList contains an invalid site.
MaxTimeExceededExceptionThe value for waitUntilDone is set to , and the pattern burst took longer than the specified maxTime.
ArgumentExceptionOne or more of the configured properties of the underlying NI-Digital Pattern Driver were invalid.

Remarks

This overload lets you select whether you want the method to wait until the pattern burst has completed before returning or the specified maxTime has elapsed. To get results after calling this method, you must call GetSitePassFail(String).

For more information, refer to the Session State Model topic of the Digital Pattern Help.

See Also

Log in to get a better experience