niRFSGPlayback_ReadWaveformsFromFileComplexF32Split

NI-RFSG Playback Library 19.1 Help

Edition Date: October 2019

Part Number: 375551G-01

»View Product Info

Download Help (Windows Only)


NI-RFSG Playback Library 19.1 Help
NI-RFSG Playback Library 20.0 Help

ViStatus __stdcall niRFSGPlayback_ReadWaveformsFromFileComplexF32Split(ViConstString filePath, ViInt32 numberOfWaveforms, ViInt32 outputBufferSizePerWaveform, ViReal64 t0[], ViReal64 dt[], ViReal32 I[], ViReal32 Q[], ViInt32 *actualSizePerWaveform);

Purpose

Reads the waveforms from file and returns the in-phase and quadrature-phase part of the waveforms in the output parameters.

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.
I ViReal32[] Returns the in-phase part of the waveforms.
Q ViReal32[] Returns the quadrature-phase part of the waveforms.
actualWaveformSize ViInt32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the outputWaveformBufferSize 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