NI-RFSG Playback Library

niRFSGPlayback_ReadWaveformFileVersionFromFile

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus __stdcall niRFSGPlayback_ReadWaveformFileVersionFromFile(ViConstString filePath, ViInt32 waveformFileVersionBufferSize, ViChar* waveformFileVersion);

Purpose

Returns the waveform file version of the waveform stored in the file.

Parameters

Input
Name Type Description
filePath ViConstString Specifies the absolute path to the TDMS file from which the playback library reads the waveforms.
waveformFileVersionBufferSize ViInt32 Specifies the buffer size of the waveformFileVersion parameter.
Output
Name Type Description
waveformFileVersion ViChar* Returns the waveform file version of the waveform stored in the file.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niRFSGPlayback_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience