Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.GraphicItemTypeGet method

Remarks

Given the unique identification number, obtains the type of graphic item.

For details about graphic items management on the waveform analyzer refer to the How to add graphic items to the Waveform analyzer section.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

Syntax

[Visual Basic]

Public Function GraphicItemTypeGet (

nUniqueId as Int16,

[C#]

public enumErrorCodes GraphicItemTypeGet (

Int16 nUniqueId,

);

[C++]

public: enumErrorCodes GraphicItemTypeGet (

Int16 nUniqueId,

);

Parameter

Description

nUniqueId

Unique identification number assigned to the graphic item.

The unique identification number of a graphic item is generated using one of the following methods:

•	WaveformAnalyzer.GraphicItemHorizontalLineAdd for horizontal lines

•	WaveformAnalyzer.GraphicItemVerticalLineAdd for vertical lines

•	WaveformAnalyzer.GraphicItemWaveRangeAdd for wave ranges

nType

Reference that, on return from the method call, will contain the type of graphic item.

Supported values are the following:

Mnemonic constant	Numeric value	Meaning
GRAPHIC_ITEM_VERTICAL_LINE	0	Vertical line
GRAPHIC_ITEM_HORIZONTAL_LINE	1	Horizontal line
GRAPHIC_ITEM_WAVE_RANGE	2	Wave range

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.