VeriStand .NET API Reference

RawDataBasedFrame.CreateFrameInformation Method

Creates a FrameInformation section under the frame, which contains channels with timing and ID information for incoming 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 CreateFrameInformation ( _
	CreateTimeInformationChannels As Boolean, _
	CreateFrameID As Boolean, _
	<OutAttribute> ByRef frameInformation As FrameInformation _
) As Boolean
C#
public bool CreateFrameInformation(
	bool CreateTimeInformationChannels,
	bool CreateFrameID,
	out FrameInformation frameInformation
)
Visual C++
public:
bool CreateFrameInformation(
	bool CreateTimeInformationChannels, 
	bool CreateFrameID, 
	[OutAttribute] FrameInformation^% frameInformation
)

Parameters

CreateTimeInformationChannels
Type: System.Boolean
If true (True in Visual Basic), creates a ReceiveTime and a TimeDifference channel under the section.
CreateFrameID
Type: System.Boolean
If true (True in Visual Basic), creates a FrameID channel under the section.
frameInformation
Type: NationalInstruments.VeriStand.SystemDefinitionAPI.FrameInformation %
Upon return, contains a reference to the FrameInformation section.

Return Value

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

Remarks

This method is only valid for incoming frames. This method does not create a section if the frame is not an incoming frame, or if a FrameInformation section already exists under the frame.

See Also

Log in to get a better experience