niRFSGPlayback_RetrieveWaveformRuntimeScaling

NI-RFSG Playback Library 2.5 Help

Edition Date: June 2018

Part Number: 375554F-01

»View Product Info
Download Help (Windows Only)

ViStatus __stdcall niRFSGPlayback_RetrieveWaveformRuntimeScaling(ViSession rfsgSession, ViConstString waveformName, ViReal64* runtimeScaling);

Purpose

Returns the runtime scaling value stored in the NI-RFSG waveform database. This function uses the waveformName as the key to retrieve the waveform property.

Parameters

Input
Name Type Description
rfsgSession ViSession Identifies the instrument session. rfsgSession is obtained from either the niRFSG_init function or the niRFSG_InitWithOptions function.
waveformName ViConstString Specifies the name of the waveform for which you want to retrieve the runtime scaling value.
Output
Name Type Description
runtimeScaling ViReal64* Returns the runtime scaling value stored in the NI-RFSG waveform database for the waveform you specified in the waveformName parameter. This value is expressed in dB.

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