TDMS Get Properties Function

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Owning Palette: TDM Streaming VIs and Functions

Requires: Base Development System

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

Returns the properties of the specified .tdms file, channel group, or channel. If you wire the group name and channel name inputs with values, the function searches for properties at the channel level. Wiring only the group name input with a value searches for properties at the channel group level. If both group name and channel name inputs contain no values, the function searches for properties at the root level of the .tdms file. If you wire the channel name input with a value, you must also wire a value to the group name input.

Example

data type controls the data type of the property values or property value output. This input accepts the following data types:
Data Type Default Value
Signed or unsigned integer 0
Single-precision or double-precision floating-point number 0
Complex single-precision or double-precision floating-point number 0+0i
(Windows) Extended-precision floating-point number 0
Alphanumeric string that does not contain null characters Empty string
Timestamp 00:00:00.000
Boolean FALSE
Variant that contains any of the data types specified above Empty variant
To return more than one property using the same function, you can wire a 1D array of any of the previously specified data types to the data type input. Each value in the array corresponds to a single property. However, a single property cannot hold an array of values.
property name specifies the name of the property whose values you want to get. If you do not wire this input, this function returns the property names and their property values for the specified group name, channel name, or the entire .tdms file. If you wire this input, the property value output replaces property values and returns the value of the specified property; the found output replaces property names and returns TRUE. If the specified property does not exist in the .tdms file, the property value output returns the default value of the specified data type and the found output returns FALSE.

tdms file specifies a reference number to the .tdms file on which to perform the operation. Use the TDMS Open function to open the refnum.
group name specifies the channel group to perform the operation on. If you wire a value to the channel name input, you must also wire a value to this input.
channel name specifies the channel to perform the operation on. If you wire a value to this input, you must also wire a value to the group name input.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
tdms file out returns a TDMS file reference to the .tdms file on which you performed the operation.
group name out returns the name of the channel group on which you performed the operation.
channel name out returns the name of the channel on which you performed the operation.
error out contains error information. This output provides standard error out functionality.
property values returns the property values of the specified channel group, channel, or .tdms file. This output is available only if the property name input is not wired. The data type of this parameter is determined by the data type input.
property value replaces the property values output and returns the property value of the specified property. This output is available only if the property name input is wired. The data type of this parameter is determined by the data type input.
property names returns the property names of the specified channel group, channel, or .tdms file. This output is available only if the property name input is not wired.
found replaces the property names output and indicates whether the specified property exists in the .tdms file or not. This output is available only if the property name input is wired.

Example

Refer to the Concurrent Access to TDMS File VI in the labview\examples\File IO\TDMS directory for an example of using the TDMS Get Properties function.

WAS THIS ARTICLE HELPFUL?

Not Helpful