RFmx BT CVI

RFmxBT_CfgFrequency

  • Updated2024-10-14
  • 1 minute(s) read

RFmxBT_CfgFrequency

int32 __stdcall RFmxBT_CfgFrequency (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 centerFrequency);

Purpose

Configures the expected carrier frequency of the RF signal to acquire. The signal analyzer tunes to this frequency.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxBT_Initialize function.
selectorString char[] Specifies a selector string comprising of the signal name. If you do not specify the signal name, the default signal instance is used.
Examples:
""
"signal::sig1"
You can use the RFmxBT_BuildSignalString function to build the selector string.
centerFrequency float64 Specifies the expected carrier frequency of the RF signal that needs to be acquired. This value is expressed in Hz. The signal analyzer tunes to this frequency. The default value of this parameter is hardware dependent. The default value for the devices PXIe-5645/5820 is 0 Hz. The default value for devices PXIe-5644/5646/5840/5663/5663E/5665/5668 is 2.402 GHz.

Return Value

Name Type Description
status int32 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 RFmxBT_GetError 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