GetAlarmFolderList Method (Boolean)

NI VeriStand 2018 Help

Edition Date: May 2018

Part Number: 372846M-01

»View Product Info
Download Help (Windows Only)

Alarms Class See Also


Gets an array that contains the AlarmFolder elements from Alarms.

Namespace: NationalInstruments.VeriStand.SystemDefinitionAPI

Assembly: NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2017.0.0.0 (2017.0.0.128)

Syntax

Visual Basic (Declaration)
Public Function GetAlarmFolderList ( _
	deep As Boolean _
) As AlarmFolder()

C#
public AlarmFolder[] GetAlarmFolderList(
	bool deep
)

Visual C++
public:
array<AlarmFolder^>^ GetAlarmFolderList(
	bool deep
)

Parameters

deep
Type: System.Boolean
Specifies whether the method traverses each child AlarmFolder element of the Alarms section. true (True in Visual Basic) if the method traverses each child AlarmFolder instance to search for other AlarmFolder instances to traverse or other AlarmFolder elements to add to the result list; otherwise false (False in Visual Basic).

Return Value

Returns an array that contains the AlarmFolder elements from the Alarms section.

Remarks

Note:Any modification that you make to the contents of this array also apply to the system definition. However, any modification that you make to the array container does not affect the system definition. For example, any modification that you make by calling Array.SetValue() or Array.Clear() does not affect the system definition.

See Also

Reference

Alarms Class

NationalInstruments.VeriStand.SystemDefinitionAPI Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful