>niRFSGPlayback_StoreWaveformPAPR

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_StoreWaveformPAPR(ViSession rfsgSession, ViConstString waveformName, ViReal64 PAPR);

Purpose

Stores the peak to average power ratio (PAPR), which you specify in the PAPR parameter, in the NI-RFSG waveform database.

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 waveform name for which you want to store the PAPR.
PAPR ViReal64 Specifies the PAPR to store in the NI-RFSG database. 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