VeriStand .NET API Reference

IDataLogging.GetCurrentLogFileInfo Method

Returns information about the current log file for the data logging session.

Namespace: NationalInstruments.VeriStand.ClientAPI.Logging
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
Visual Basic (Declaration)
Function GetCurrentLogFileInfo ( _
	sessionName As String, _
	<OutAttribute> ByRef logFilePath As String, _
	<OutAttribute> ByRef size As Long, _
	<OutAttribute> ByRef startTime As DateTime _
) As Error
C#
Error GetCurrentLogFileInfo(
	string sessionName,
	out string logFilePath,
	out long size,
	out DateTime startTime
)
Visual C++
Error^ GetCurrentLogFileInfo(
	String^ sessionName, 
	[OutAttribute] String^% logFilePath, 
	[OutAttribute] long long% size, 
	[OutAttribute] DateTime% startTime
)

Parameters

sessionName
Type: System.String
Specifies the unique name of the data logging session.
logFilePath
Type: System.String %
Indicates the file path of the current log file.
size
Type: System.Int64 %
Indicates the file size in bytes of the current log file.
startTime
Type: System.DateTime %
Indicates the time when the current log file was opened.

Return Value

Returns an Error object. If no error occurs, the Code property of the Error object is 0.

See Also

Log in to get a better experience