IviSpecAn_QueryMarker

CVI/LabWindows IVI Class Driver

IviSpecAn_QueryMarker

IviSpecAnMarker Capability Group

C Function Prototype

ViStatus IviSpecAn_QueryMarker (ViSession vi, ViReal64* markerPosition, ViReal64* markerAmplitude);

Purpose

This function returns the horizontal position and the marker amplitude level of the active marker.

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

markerPosition ViReal64 Returns the horizontal position of the active marker from the IVISPECAN_ATTR_MARKER_POSITION attribute.

markerAmplitude ViReal64 Returns the amplitude value of the active marker from the IVISPECAN_ATTR_MARKER_AMPLITUDE attribute.

Units: The units are specified by the IVISPECAN_ATTR_AMPLITUDE_UNITS attribute, except when the IVISPECAN_ATTR_MARKER_TYPE attribute is set to Delta. When IVISPECAN_ATTR_MARKER_TYPE is set to Delta the units are dB.

Return Values