VeriStand .NET API Reference

RawDataBasedFrame.CreateFrameFaulting Method

Creates a FrameFaulting section under the frame, which contains channels you can use to control the transmission of outgoing cyclic frames.

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 CreateFrameFaulting ( _
	CreateSkipCyclicFrames As Boolean, _
	CreateTransmitTime As Boolean, _
	<OutAttribute> ByRef frameFaulting As FrameFaulting _
) As Boolean
C#
public bool CreateFrameFaulting(
	bool CreateSkipCyclicFrames,
	bool CreateTransmitTime,
	out FrameFaulting frameFaulting
)
Visual C++
public:
bool CreateFrameFaulting(
	bool CreateSkipCyclicFrames, 
	bool CreateTransmitTime, 
	[OutAttribute] FrameFaulting^% frameFaulting
)

Parameters

CreateSkipCyclicFrames
Type: System.Boolean
If true (True in Visual Basic), creates a SkipCyclicFrames channel under the section.
CreateTransmitTime
Type: System.Boolean
If true (True in Visual Basic), creates a TransmitTime channel under the section.
frameFaulting
Type: NationalInstruments.VeriStand.SystemDefinitionAPI.FrameFaulting %
Upon return, contains a reference to the FrameFaulting section.

Return Value

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

Remarks

This method is only valid for outgoing cyclic frames under CAN ports. This method does not create a section if the frame is not an outgoing cyclic frame of a CAN port, or if a FrameFaulting section already exists under the frame.

See Also

Log in to get a better experience