RFmx GSM CVI

RFmxGSM_ORFSCfgSwitchingCustomOffsetFrequencyArray

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

RFmxGSM_ORFSCfgSwitchingCustomOffsetFrequencyArray

int32 __stdcall RFmxGSM_ORFSCfgSwitchingCustomOffsetFrequencyArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float32 switchingCustomOffsetFrequency[], int32 arraySize);

Purpose

Configures an array of positive offset frequencies relative to the carrier frequency for the spectrum measurement because of switching when you set the RFMXGSM_ATTR_ORFS_OFFSET_FREQUENCY_MODE attribute to RFMXGSM_VAL_ORFS_OFFSET_FREQUENCY_MODE_CUSTOM.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxGSM_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.
Example:
"signal::sig1"
You can use the RFmxGSM_BuildSignalString function to build the selector string.
switchingCustomOffsetFrequency float32[] Specifies an array of positive offset frequencies relative to the frequency of the carrier for the spectrum measurement because of switching when you set the RFMXGSM_ATTR_ORFS_OFFSET_FREQUENCY_MODE attribute to RFMXGSM_VAL_ORFS_OFFSET_FREQUENCY_MODE_CUSTOM. This value is expressed in Hz. The lower offset frequency or the negative offset value corresponding to each entry is automatically considered for the measurement.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.

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 RFmxGSM_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors