IviSpecAn_GetMarkerName
IviSpecAnMarker Capability Group
C Function Prototype
ViStatus IviSpecAn_GetMarkerName (ViSession vi, ViInt32 index, ViInt32 nameBufferSize, ViChar[] name);
Purpose
This function returns the specific driver defined trace name that corresponds to the one-based index specified by the Index parameter. If you pass in a value for the Index parameter that is less than one or greater than the value of the IVISPECAN_ATTR_MARKER_COUNT attribute, the function returns an empty string in the Name parameter and returns the Invalid Value error.
Note: For an instrument with only one Marker, i.e. the IVISPECAN_ATTR_MARKER_COUNT attribute is one, the driver may return an empty string.
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 |
| index | ViInt32 | Specifies the index of the Marker Name to return.
Default Value: 0 |
| nameBufferSize | ViInt32 | Specify the buffer size for the Name parameter.
Default Value: 0 |
| name | ViChar[] | The marker name that corresponds to the Index.
The Name buffer must contain at least as many elements as the value you specify with the Name Buffer Size parameter. |