IviFgen_GetDataMarkerName
- Updated2023-02-24
- 2 minute(s) read
IviFgenDataMarker [DM] Capability Group
C Function Prototype
ViStatus IviFgen_GetDataMarkerName (ViSession instrumentHandle, ViInt32 markerIndex, ViInt32 nameBufferSize, ViChar markerName[]);
Purpose
This function returns the repeated capability identifier for the data marker that corresponds to the one-based index that you specify. If the value you specify for the index parameter is less than one or greater than the value of the data marker count, the function returns an empty string in the name parameter and returns an error.
Parameters
| Input | ||
| Name | Type | Description |
|---|---|---|
| instrumentHandle | ViSession | The ViSession handle that you obtain from the IviFgen_init or IviFgen_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| markerIndex | ViInt32 | A one-based index that defines which marker name to return. Valid values for the markerIndex parameter are between one and the value of the IVIFGEN_ATTR_DATAMARKER_COUNT attribute, inclusive. Default Value: 1 |
| nameBufferSize | ViInt32 | Pass the number of bytes in the ViChar array that the you for the markerName parameter. If the marker name, including the terminating NUL byte, contains more bytes than you indicate in this parameter, the function copies nameBufferSize - 1 bytes into the buffer, places an ASCII NUL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the nameBufferSize is 4, the function places "123" into the buffer and returns 7. If you pass a negative number, the function copies the value to the buffer regardless of the number of bytes in the value. If you pass 0, you can pass VI_NULL for the markerName parameter. Default Value: None |
| Output | ||
| Name | Type | Description |
| markerName | ViChar[] | Returns the marker name of the data marker that is in the data marker collection at the index you specify. |