Copyright © 2008-2013 MultiMedia Soft

GraphicItemVertPositionGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current vertical position of the given graphic item. The vertical position can be modified through the 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.

 

 

Syntax

 

[Visual Basic]

Public Function GraphicItemVertPositionGet (

nUniqueId as Int16,

ByRef nPosInPerc as Int32

) as enumWanErrorCodes


 

[C#]

public enumWanErrorCodes GraphicItemVertPositionGet (

Int16 nUniqueId,

ref Int32 nPosInPerc

);


 

[C++]

public: enumWanErrorCodes GraphicItemVertPositionGet (

Int16 nUniqueId,

Int32 __gc *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:

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)

enumWanErrorCodes.ERR_WAN_NOERROR (0)

The method call was successful.