rfsa c api reference

niRFSA_ConfigureSpectrumFrequencyStartStop

  • Updated2024-05-08
  • 2 minute(s) read

niRFSA_ConfigureSpectrumFrequencyStartStop

ViStatus niRFSA_ConfigureSpectrumFrequencyStartStop(ViSession vi, ViConstString channelList, ViReal64 startFrequency, ViReal64 stopFrequency);

Purpose

Configures the start and stop frequencies of a spectrum read by NI-RFSA.

Note Note  If you configure the spectrum span (stopFrequencystartFrequency) to a value larger than the instantaneous bandwidth of the device, NI-RFSA performs multiple acquisitions and combines them into a spectrum of the size you request.
Note   For the PXIe-5663/5663E, NI-RFSA does not support multispan acquisitions from frequency ranges that correspond with different instantaneous bandwidths. For example, you cannot configure a multispan acquisition that acquires one span from 110 MHz to 120 MHz and a second from 120 MHz to 130 MHz because the bandwidths that correspond to each span are different (10 MHz and 20 MHz, respectively).

Supported Devices: PXI-5600, PXIe-5601/5603/5605/5606 (external digitizer mode), PXIe-5644/5645/5646, PXI-5661, PXIe-5663/5663E/5665/5667/5668, PXIe-5820/5830/5831/5832/5840/5841/5842

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the niRFSA_init or niRFSA_InitWithOptions function.
channelList ViConstString Identifies which channels to apply settings. Specify an empty string as the value of this parameter.
startFrequency ViReal64 Specifies the lower limit of a span of frequencies. This value is expressed in hertz (Hz).
stopFrequency ViReal64 Specifies the upper limit of a span of frequencies. This value is expressed in hertz (Hz).

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 NI-RFSA 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 niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience