VeriStand .NET API Reference

Table of Contents

CustomDeviceSection.AddCustomDeviceWaveformIfNotFound Method

Adds a CustomDeviceWaveform with the name, dataType and guid you specify to the current section, if the CustomDeviceWaveform does not already exist under the section. If the CustomDeviceWaveform you specify already exists, this method takes no action and returns a reference to the existing CustomDeviceWaveform.

Namespace: NationalInstruments.VeriStand.SystemDefinitionAPI
Assembly: NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Public Function AddCustomDeviceWaveformIfNotFound ( _
	name As String, _
	guid As String, _
	dataType As WaveformTypeDataType, _
	<OutAttribute> ByRef newItem As Boolean _
) As CustomDeviceWaveform
C#
public CustomDeviceWaveform AddCustomDeviceWaveformIfNotFound(
	string name,
	string guid,
	WaveformTypeDataType dataType,
	out bool newItem
)
Visual C++
public:
CustomDeviceWaveform^ AddCustomDeviceWaveformIfNotFound(
	String^ name, 
	String^ guid, 
	WaveformTypeDataType dataType, 
	[OutAttribute] bool% newItem
)

Parameters

name
Type: System.String
The name associated with the CustomDeviceWaveform, as specified in the Custom Device XML file.
guid
Type: System.String
The GUID associated with the CustomDeviceWaveform, as specified in the Custom Device XML file.
dataType
Type: WaveformTypeDataType
The data type associated with the CustomDeviceWaveform which is an enumeration value of WaveformTypeDataType.
newItem
Type: System.Boolean %
Returns true (True in Visual Basic) if the CustomDeviceWaveform was added.

Return Value

The CustomDeviceWaveform reference for the waveform specified by name, dataType and guid.

See Also

Log in to get a better experience