IviSpecAn_MarkerSearch

CVI/LabWindows IVI Class Driver

IviSpecAn_MarkerSearch

IviSpecAnMarker Capability Group

C Function Prototype

ViStatus IviSpecAn_MarkerSearch (ViSession vi, ViInt32 markerSearch);

Purpose

This function specifies the type of marker search and performs the search.

This function returns the Marker Not Enabled error (0x0xBFFA2001) if the IVISPECAN_ATTR_MARKER_ENABLED attribute is set to VI_FALSE.

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

markerSearch ViInt32 Specifies the type of marker search to perform.

Valid Values:
IVISPECAN_VAL_MARKER_SEARCH_HIGHEST
- Sets marker search for the highest amplitude.

IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK
- Sets marker search for the next highest peak.

IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_LEFT
- Sets marker search for the next peak left of the peak amplitude.

IVISPECAN_VAL_MARKER_SEARCH_NEXT_PEAK_RIGHT
- Sets marker search for the next peak right of the peak amplitude.

IVISPECAN_VAL_MARKER_SEARCH_MINIMUM
- Sets marker search for the minimum amplitude.

Default Value: IVISPECAN_VAL_MARKER_SEARCH_MINIMUM

Return Values