IviSpecAn_SetActiveMarker

CVI/LabWindows IVI Class Driver

IviSpecAn_SetActiveMarker

IviSpecAnMarker Capability Group

C Function Prototype

ViStatus IviSpecAn_SetActiveMarker (ViSession vi, ViConstString activeMarker);

Purpose

This function selects one of the available markers, and makes it the active marker. The active marker must be enabled using the IviSpecAn_ConfigureMarkerEnabled function before it can be used for most marker operations.

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

activeMarker ViConstString Pass the name of the marker to be selected. The driver uses this value to set the IVISPECAN_ATTR_ACTIVE_MARKER attribute.

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

Virtual repeated capability names are aliases for instrument-specific marker strings. The instrument-specific marker 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 marker name as a string variable or as a literal enclosed in double quotes.

Return Values