IviSpecAn_ConfigureMarkerEnabled

CVI/LabWindows IVI Class Driver

IviSpecAn_ConfigureMarkerEnabled

IviSpecAnMarker Capability Group

C Function Prototype

ViStatus IviSpecAn_ConfigureMarkerEnabled (ViSession vi, ViBoolean markerEnabled, ViConstString markerTraceName);

Purpose

This function enables the active marker on the specified trace.

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

markerEnabled ViBoolean Specifies whether the specified marker is enabled. The driver uses this value to set the IVISPECAN_ATTR_MARKER_ENABLED attribute.

Valid Values: VI_TRUE; VI_FALSE

Default Value: VI_FALSE

markerTraceName ViConstString Pass the name of the trace you for which you are enabling the active marker.

This control accepts either a virtual repeated capability name or an instrument-specific trace name.

Virtual repeated capability names are aliases for instrument-specific trace strings. The instrument-specific trace strings can differ from one instrument to another. Virtual repeated capability names allow you to use and swap instruments without having to change the trace names in your source code. You specify virtual repeated capability names in MAX.


Default Value: ""

Note:

You can specify the trace name as a string variable or as a literal enclosed in double quotes.

Return Values