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

Reads the specified .tdms file and returns data in a format specified by the data type input. Use the count and offset inputs to read a specified subset of the data.

Examples

	count is the maximum number of data elements to read from the .tdms file for each channel.
	offset determines the number of data elements into the .tdms file at which the function begins analyzing the .tdms file. The default is 0.
	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 in indicates the group name to perform the operation on. If this input remains unwired, the default is Untitled.
	channel names in indicates the channel to perform the operation on. If this input remains unwired, the channels are named automatically. If you wire waveform data to the data input, LabVIEW uses waveform names.
	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.
	data type is the type of data that you want data to contain. This input accepts the following data types: Waveform or a 1D array of waveforms Digital table Dynamic data 1D or 2D array of: Signed or unsigned integers Single, double, or extended precision numerics Alphanumeric strings that do not contain null characters Timestamps Booleans
	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.
	data contains the data read from the file in the specified data type. It can consist of any data type depending on which data type you specify in data type and how count is set.
	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.
	eof indicates if the end of the file has been reached.

Examples

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

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