IviSpecAn_SetInstrumentFromMarker
IviSpecAnMarker Capability Group
C Function Prototype
ViStatus IviSpecAn_SetInstrumentFromMarker (ViSession vi, ViInt32 instrumentSetting);
Purpose
This function uses the IVISPECAN_ATTR_MARKER_POSITION or IVISPECAN_ATTR_MARKER_AMPLITUDE attribute to configure the spectrum analyzer according to value of the InstrumentSetting parameter. For example, setting the Instrument Setting parameter to Frequency Center sets the center frequency to the value of the IVISPECAN_ATTR_MARKER_POSITION attribute.
This function may set the IVISPECAN_ATTR_FREQUENCY_START, IVISPECAN_ATTR_FREQUENCY_STOP, or IVISPECAN_ATTR_REFERENCE_LEVEL attributes.
If the IVISPECAN_ATTR_MARKER_ENABLED attribute is set to VI_FALSE, this function returns the Marker Not Enabled error (0xBFFA2001). If the IVISPECAN_ATTR_MARKER_TYPE attribute is not Delta and the InstrumentSetting parameter is Frequency Span, the function returns the Not Delta Marker error (0xBFFA2002).
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviSpecAn_init or IviSpecAn_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| instrumentSetting | ViInt32 | Specifies the instrument setting to be set from the marker position.
Defined Values: Frequency Center - IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_CENTER Frequency Span - IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_SPAN Frequency Start - IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_START Frequency Stop - IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_STOP Reference Level - IVISPECAN_VAL_INSTRUMENT_SETTING_REFERENCE_LEVEL Default Value: Frequency Center - IVISPECAN_VAL_INSTRUMENT_SETTING_FREQUENCY_CENTER |