Table Of Contents

TDMS Open (G Dataflow)

    Last Modified: March 8, 2017

    Obtains a reference to a .tdms file so that you can read or write to the file.

    You can also use this node to create a new file or replace an existing file.

    Copyright: (c) 2016 National Instruments. All rights reserved.


    create index file

    A Boolean that determines whether to generate a .tdms_index file for a .tdms file. The .tdms_index file speeds up random access to the .tdms file.

    TRUE Generates a .tdms_index file.
    FALSE Does not generate a .tdms_index file.

    Is the Index File Necessary?

    The .tdms_index file is optional in TDMS applications. When you distribute a TDMS application or .tdms file to another computer, you do not need to include the corresponding .tdms_index file. For example, if you have limited disk space, you do not need to generate the .tdms_index file.

    Behavior of Using Multiple TDMS Open Nodes to Open the Same File

    To open the same .tdms file using multiple TDMS Open nodes, LabVIEW uses create index file? of the first TDMS Open node to determine whether to generate the .tdms_index file or not. LabVIEW ignores create index file? of all subsequent TDMS Open nodes.

    Default: TRUE


    file format version

    File format version for the .tdms file.

    Name Description

    The file format version is 1.0.


    The file format version is 2.0.

    Default: 2.0


    file path

    Absolute path to the .tdms file on which to perform the operation.



    Operation to perform on the .tdms file.

    Name Description

    Opens a .tdms file.

    open or create

    Opens an existing .tdms file or creates a new .tdms file if it does not exist.

    create or replace

    Creates a new .tdms file or replaces a .tdms file if it exists.


    Creates a new .tdms file.

    open (read-only)

    Opens a read-only version of the .tdms file.

    Default: open


    byte order

    Byte order, or endian format, of the data in the .tdms file. Byte order specifies whether to represent numeric values in memory from most significant byte to least significant byte or vice versa.

    byte order is valid only if you use this node to create a new .tdms file. If you use this node to read an existing .tdms file, LabVIEW reads data in the byte order of that file and represents the data in the native byte order of the host computer. If you use this node to update an existing .tdms file, LabVIEW writes data in the byte order of that file.

    Name Description
    big-endian, network order

    The most-significant byte occupies the lowest memory address.

    native, host order

    Uses the byte-ordering format of the host computer.


    The least-significant byte occupies the lowest memory address.

    Default: little-endian


    error in

    Error conditions that occur before this node runs. The node responds to this input according to standard error behavior.

    Default: No error


    disable buffering

    A Boolean that specifies whether to open, create, or replace a .tdms file without system buffering.

    TRUE The node disables system buffering and enables buffering in the TDMS disk cache.
    FALSE The node enables system buffering.

    When to Disable System Buffering

    Disabling system buffering can speed up data transfers If you have a large amount of data to transfer. To read or write a data file to a Redundant Array of Independent Disks (RAID), consider opening the file without system buffering to speed up data transfers. To read the same set of data repeatedly from the computer, consider enabling system buffering.

    Default: TRUE


    tdms file out

    A reference to the .tdms file.


    error out

    Error information. The node produces this output according to standard error behavior.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Recently Viewed Topics