Copyright © 2008-2013 MultiMedia Soft

GraphicItemTypeGet method

Previous pageReturn to chapter overviewNext page

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.

 

 

Syntax

 

[Visual Basic]

Public Function GraphicItemTypeGet (

nUniqueId as Int16,

ByRef nType as enumGraphicItemType

) as enumWanErrorCodes


 

[C#]

public enumWanErrorCodes GraphicItemTypeGet (

Int16 nUniqueId,

ref enumGraphicItemType nType

);


 

[C++]

public: enumWanErrorCodes GraphicItemTypeGet (

Int16 nUniqueId,

enumGraphicItemType __gc *nType

);


 

 

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
GraphicItemVerticalLineAdd for vertical lines
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)

enumWanErrorCodes.ERR_WAN_NOERROR (0)

The method call was successful.