NI-DAQmx .NET Framework 4.0 API Reference

Table of Contents

Task.ConfigureLogging Method (String, TdmsLoggingOperation, LoggingMode, String)

  • Updated2023-02-21
  • 2 minute(s) read
Task.ConfigureLogging Method (String, TdmsLoggingOperation, LoggingMode, String)
Configures logging to a .tdms file when the acquisition starts with the specified TDMS channel group name.

Namespace:  NationalInstruments.DAQmx
Assembly:  NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302

Syntax

public void ConfigureLogging(
	string filePath,
	TdmsLoggingOperation loggingOperation,
	LoggingMode loggingMode,
	string groupName
)
Public Sub ConfigureLogging ( 
	filePath As String,
	loggingOperation As TdmsLoggingOperation,
	loggingMode As LoggingMode,
	groupName As String
)

Parameters

filePath
Type: SystemString
The path to the .tdms file to which you want to log data. If you use this method to create a new file, the file extension of the filename you specify in filePath must be .tdms. Otherwise, this method automatically appends .tdms to the filename you specify. If you use this method to open or update an existing file, you do not have to ensure that the file extension is .tdms.
loggingOperation
Type: NationalInstruments.DAQmxTdmsLoggingOperation
A TdmsLoggingOperation value which specifies how to open the .tdms file.
loggingMode
Type: NationalInstruments.DAQmxLoggingMode
A LoggingMode value which specifies how to log data.
groupName
Type: SystemString
The name of the channel group to create within the .tdms file for data from this task. When set to , Empty, or a string with only white space, the driver sets the TDMS channel group name to the task name.

Remarks

When you enable TDMS logging, NI-DAQmx streams the data acquired to the specified file once the acquisition starts. The data written on the file is in TDMS file format, and the driver also creates a TDMS index file. Refer to TDMS Streaming for more information.

See Also

Log in to get a better experience