GetOffsetFrequency(string, out double)
- Updated2025-10-13
- 1 minute(s) read
Gets the center or edge frequency, in hertz (Hz), of the offset channel, relative to the center frequency of the closest carrier as determined by the SetOffsetFrequencyDefinition(string, RFmxSpecAnMXAcpOffsetFrequencyDefinition) method. The sign of offset frequency is ignored and the SetOffsetSideband(string, RFmxSpecAnMXAcpOffsetSideband) method determines whether the upper, lower, or both offsets are measured.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int GetOffsetFrequency(string selectorString, out double value)
Remarks
This method maps to the RFmxSpecAn_ACPGetOffsetFrequency() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies the offset number. Example: "offset0". You can use the BuildOffsetString2(string, int) method to build the selector string. |
| value | out double | Upon return, contains the center or edge frequency, in hertz (Hz), of the offset channel, relative to the center frequency of the closest carrier as determined by the SetOffsetFrequencyDefinition(string, RFmxSpecAnMXAcpOffsetFrequencyDefinition) method. The sign of offset frequency is ignored and the SetOffsetSideband(string, RFmxSpecAnMXAcpOffsetSideband) method determines whether the upper, lower, or both offsets are measured. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.