VeriStand .NET API Reference

Utilities.IsValidSequenceFile Method

Determines whether the file at the specified path can be converted to a RealTimeSequence.

Namespace: NationalInstruments.VeriStand.RealTimeSequenceDefinitionApi
Assembly: NationalInstruments.VeriStand.RealTimeSequenceDefinitionApi (in NationalInstruments.VeriStand.RealTimeSequenceDefinitionApi.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Public Shared Function IsValidSequenceFile ( _
	path As String, _
	<OutAttribute> ByRef parseException As Exception _
) As Boolean
C#
public static bool IsValidSequenceFile(
	string path,
	out Exception parseException
)
Visual C++
public:
static bool IsValidSequenceFile(
	String^ path, 
	[OutAttribute] Exception^% parseException
)

Parameters

path
Type: System.String
The path to the file to test.
parseException
Type: System.Exception %
Upon return, an exception that contains the first error encountered while parsing the file. If the file is a valid sequence file, this parameter returns a null reference (Nothing in Visual Basic).

Return Value

true (True in Visual Basic) if the method can successfully parse the file into a sequence. false (False in Visual Basic) if the method encounters an exception while parsing the file.

See Also

Log in to get a better experience