Copyright © 2013-2014 MultiMedia Soft

GraphicItemUniqueIdGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the unique identification number of a specific graphic item of a given type.

 

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]

control.GraphicItemUniqueIdGet (

nType as enumGraphicItemType,

nIndex as Integer,

ByRef nUniqueId as Integer

) as enumWanErrorCodes


 

[C++]

short control.GraphicItemUniqueIdGet (

enumGraphicItemType nType,

short nIndex,

short *nUniqueId

);


 

 

Parameter

Description

 

 

nType

The type of graphic item.

Supported values are the following:

Mnemonic constant

Numeric value

Meaning

GRAPHIC_ITEM_VERTICAL_LINE

0

Vertical lines

GRAPHIC_ITEM_HORIZONTAL_LINE

1

Horizontal lines

GRAPHIC_ITEM_WAVE_RANGE

2

Wave ranges

nIndex

Zero-based index of the graphic item. The total number of available graphic items can be obtained through the GraphicItemsTypeCountGet method.

It's important to note that, after eventually removing graphic items through the GraphicItemRemove method, you will have to perform a new call to the GraphicItemsTypeCountGet in order to have an update enumeration of graphic items and in order to avoid misalignments of the zero-based index.

nUniqueId

Reference that, on return from the method call, will contain the unique identification number of the given graphic item.

 

 

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.