Returns the signal bandwidth stored in the NI-RFSG waveform database. This function uses the waveformName as the key to retrieve the waveform property.

Syntax

int32 __stdcall niRFSGPlayback_RetrieveWaveformSignalBandwidth(ViSession rfsgSession, ViConstString waveformName, ViReal64 signalBandwidth)

Parameters

NameDirectionTypeDescription
rfsgSession[in]ViSession

Identifies the instrument session. rfsgSession is obtained from either the niRFSG_init function or the niRFSG_InitWithOptions function.

waveformName[in]ViConstString

Specifies the name of the waveform for which you want to retrieve the waveform signal bandwidth.

signalBandwidth[out]ViReal64

Returns the signal bandwidth, stored in the NI-RFSG waveform database, for the waveform you specified in the waveformName parameter.

Returns

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