BurstPattern(string, string, bool, TimeSpan)
- Updated2026-01-12
- 2 minute(s) read
Bursts the pattern on the sites you specify, waits for the burst to complete, and returns comparison results for each site.
Syntax
Namespace: NationalInstruments.ModularInstruments.NIDigital
public bool[] BurstPattern(string siteList, string startLabel, bool selectDigitalFunction, TimeSpan maxTime)
Remarks
Digital pins retain their state at the end of a pattern burst until the first vector of the pattern burst, a call to WriteStatic, or a call to ApplyLevelsAndTiming(string, string, string).
This overload will burst the pattern to completion and then return the site pass/fail results. Call this overload when you want to wait until the pattern burst is complete before continuing program execution.
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. |
| maxTime | TimeSpan | The maximum time interval allowed for the pattern burst to complete. |
Returns
An array of System.Boolean values for each site. true, if the site passed; false, if the site failed. If a site is disabled or not enabled for burst, the method does not return data for that site. Use SortSiteResultsBySite(NIDigital[], string, SiteResultType, bool[][], out int[]) to order and combine the data to match siteList . You can also use GetSiteResultsSiteNumbers to obtain a sorted list of returned sites.
Exceptions
| Type | Description |
|---|---|
| Ivi.Driver.IviCDriverException | The NI-Digital Pattern Driver returned an error. |
| System.InvalidOperationException | BurstPattern(string, string, bool, TimeSpan) is called without loading a pattern. |
| Ivi.Driver.SelectorNameException | The value for siteList contains an invalid site. |
| Ivi.Driver.MaxTimeExceededException | 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. |