Returns the sample rate stored in the file. This method uses the waveformIndex as the key to read the waveform property.

Syntax

Namespace: NationalInstruments.ModularInstruments.NIRfsgPlayback

public static int ReadSampleRateFromFile(string filePath, int waveformIndex, out double sampleRate)

Parameters

NameTypeDescription
filePathstring

Specifies the absolute path to the TDMS file from which the playback library reads the waveform.

waveformIndexint

Specifies the waveform number in the file for which you want to read the sample rate.

sampleRateout double

Returns the sample rate value, stored in the file for the waveform number you specified in the waveformIndex parameter.

Returns

Returns the status code of this method. The status code either indicates success or describes a warning condition.