BurstPattern(string, string, bool, bool, TimeSpan)
- Updated2026-01-12
- 1 minute(s) read
Starts a pattern burst and optionally blocks program execution until the pattern burst is complete.
Syntax
Namespace: NationalInstruments.ModularInstruments.NIDigital
public void BurstPattern(string siteList, string startLabel, bool selectDigitalFunction, bool waitUntilDone, TimeSpan maxTime)
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.
Parameters
| Name | Type | Description |
|---|---|---|
| siteList | string | 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 | string | The pattern name or exported pattern label from which to start bursting the pattern. |
| selectDigitalFunction | bool | If true, sets the SelectedFunction of the pins to Digital. |
| waitUntilDone | bool | If true, waits until the pattern burst is completed; otherwise, initiates a pattern burst and returns. |
| maxTime | TimeSpan | The maximum time interval allowed for the pattern burst to complete. |
Exceptions
| Type | Description |
|---|---|
| Ivi.Driver.IviCDriverException | The NI-Digital Pattern Driver returned an error. |
| System.InvalidOperationException | BurstPattern(string, string, bool, bool, TimeSpan) is called before loading a pattern. |
| Ivi.Driver.SelectorNameException | The value for siteList contains an invalid site. |
| Ivi.Driver.MaxTimeExceededException | The value for waitUntilDone is set to true, and the pattern burst took longer than the specified maxTime . |
| System.ArgumentException | One or more of the configured properties of the underlying NI-Digital Pattern Driver were invalid. |