TdmsFile Class

Measurement Studio 2019 Help

Edition Date: May 2019

Part Number: 375857B-01

»View Product Info
Download Help (Windows Only)

Members See Also


Note: This topic applies to the following Measurement Studio editions: Enterprise, Professional.

Provides support for creating new TDMS files and reading from and writing to existing TDMS files.

Namespace: NationalInstruments.Tdms

Assembly: NationalInstruments.Tdms (in NationalInstruments.Tdms.dll) Version: 19.0.40.49153 (19.0.40.49153)

Syntax

Visual Basic (Declaration)
Public NotInheritable Class TdmsFile _
	Implements ITdmsContainerObject, IDisposable

C#
public sealed class TdmsFile : ITdmsContainerObject, 
	IDisposable

Remarks

You can create new TDMS files or open existing files for edit using TdmsFile. You can get and set the file Name, Description, Title, and Author after the TdmsFile is opened.

Use GetChannelGroups and GetProperties to access the channel groups and properties associated with this TdmsFile. GetChannelGroups and GetProperties create new collections when they are called, but are not updated if the TDMS file changes on disk. You must call these methods when you want to update TdmsFile.

After writing to the TDMS file, it must be saved before it can be read from again. Use Save to save changes to the file to disk. Use Close to close the TDMS file.

Use Defragment to defragment a TDMS file on disk. The TDMS file is reorganized on disk so that all the data for each channel is located together. If a file is heavily fragmented then defragmenting the file will speed up read operations.

Inheritance Hierarchy

System.Object
  NationalInstruments.Tdms.TdmsFile

Thread Safety

All members of this type are safe for multithreaded operations.

See Also

Reference

TdmsFile Members

NationalInstruments.Tdms Namespace

WAS THIS ARTICLE HELPFUL?

Not Helpful