VeriStand .NET API Reference

SignalBasedFrame.CreateMode Method

Creates a Mode section under the frame, which organizes multiplexed signals.

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 CreateMode ( _
	MultiplexerValue As Integer, _
	SignalName As String, _
	Description As String, _
	Units As String, _
	DefaultValue As Double, _
	<OutAttribute> ByRef mode As Mode _
) As Boolean
C#
public bool CreateMode(
	int MultiplexerValue,
	string SignalName,
	string Description,
	string Units,
	double DefaultValue,
	out Mode mode
)
Visual C++
public:
bool CreateMode(
	int MultiplexerValue, 
	String^ SignalName, 
	String^ Description, 
	String^ Units, 
	double DefaultValue, 
	[OutAttribute] Mode^% mode
)

Parameters

MultiplexerValue
Type: System.Int32
The value of the multiplexer signal, which determines the dynamic signals transmitted in the frame. This method creates a section named "Mode MultiplexerValue".
SignalName
Type: System.String
The name of a dynamic, or multiplexed, signal to add under the Mode section.
Description
Type: System.String
A description of the multiplexed SignalName.
Units
Type: System.String
The units associated with SignalName.
DefaultValue
Type: System.Double
The default value of SignalName.
mode
Type: NationalInstruments.VeriStand.SystemDefinitionAPI.Mode %
Upon return, contains a reference to the Mode class.

Return Value

true (True in Visual Basic) if the section is created.

Remarks

This method is only valid for frames under CAN ports.

See Also

Log in to get a better experience