You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Returns the properties of the specified .tdms file, channel group, or channel. The function returns the group and/or channel properties if you wire the group name or channel name inputs with values. If those inputs contain no values, the function returns the property values for the specified .tdms file.

Details  Examples

	data type controls the data type of the property values parameter. This input accepts the following data types: Signed or unsigned integer Single, double, or extended precision numeric Alphanumeric string that does not contain null characters Timestamp Boolean Variant that contains any of the data types specified above 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 indicates which property to return the property values of. If this input remains unwired, the function returns the property values for the specified group name, channel name, or the entire .tdms file.
	tdms file is a refnum to the .tdms file to perform the operation on. Use the TDMS Open function to open the refnum.
	group name specifies the channel group to perform the operation on.
	channel name indicates the channel to perform the operation on.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	tdms file out generates a refnum to the .tdms file you performed the operation on.
	group name out returns the group name you performed the operation on.
	channel name(s) out returns the channel name you performed the operation on.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.
	property values returns the property values of the specified property, channel group, channel, or .tdms file. 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.

TDMS Get Properties Details

You can use the TDMS Get Properties function to obtain the values for the built-in TDMS properties, NI_ChannelLength and NI_DataType. NI_ChannelLength is an integer that represents the number of values in a channel of a TDMS file. NI_DataType represents the data type of a TDMS channel. The value for NI_DataType is an integer that corresponds to a LabVIEW type code. Both properties are read-only.

Examples

Refer to the following VIs for examples of using the TDMS Get Properties function:

• Read Channel Groups (TDMS) VI: labview\examples\file\storage.llb
• TDMS - Concurrent File Access VI: labview\examples\file\plat-tdms.llb