COM Objects > WaveformAnalyzer object > Methods > WaveformAnalyzer.GraphicItemVertPositionGet method

Remarks

Obtains the current vertical position of the given graphic item. The vertical position can be modified through the WaveformAnalyzer.GraphicItemVertPositionSet method or through the mouse.

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 object section.

Syntax

[Visual Basic]

control.WaveformAnalyzer.GraphicItemVertPositionGet (

nUniqueId as Integer,

ByRef nPosInPerc as Long

) as enumErrorCodes

[C++]

short control.WaveformAnalyzer.GraphicItemVertPositionGet (

short nUniqueId,

long *nPosInPerc

);

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

nPosInPerc

Reference that, on return from the method call, will contain the position of the item expressed in percentage of wave amplitude.

May assume values from -100 to 100: a negative value indicates that the line should be drawn over negative waveform peaks.

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.