niRFSGPlayback_ReadWaveformsFromFileComplexF64

NI-RFSG Playback Library 3.0 Help

Edition Date: January 2019

Part Number: 375551E-01

»View Product Info
Download Help (Windows Only)

ViStatus __stdcall niRFSGPlayback_ReadWaveformsFromFileComplexF64 (ViConstString filePath, ViInt32 numberOfWaveforms, ViInt32 outputBufferSizePerWaveform, ViReal64 t0[], ViReal64 dt[], NIComplexNumber outputWaveforms[], ViInt32 *actualSizePerWaveform);

Purpose

Reads the waveforms from file and returns the waveforms in an output parameter.

Parameters

Input
Name Type Description
filePath ViConstString Specifies the absolute path to the TDMS file from which the playback library reads the waveforms.
numberOfWaveforms ViInt32 Specifies the number of waveforms to read.
outputBufferSizePerWaveform ViInt32 Specifies the size of the outputWaveform array. Set the outputBufferSizePerWaveform parameter to 0 to get the size of the outputWaveform array in the actualWaveformSize parameter.
Output
Name Type Description
t0 ViReal64[] This element should be ignored.
dt ViReal64[] Returns the inverse of the sample rate of the waveform.
outputWaveforms NIComplexNumberF32[] Returns the complex waveform samples stored in an array.
actualSizePerWaveform ViInt32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the outputBufferSizePerWaveform parameter to 0.

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

WAS THIS ARTICLE HELPFUL?

Not Helpful