Methods > Graphic items management > GraphicItemsTypeCountGet method

Remarks

Obtains the total number of graphic items of a given type added to the waveform analyzer.

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 GraphicItemsCountGet in order to have an update enumeration of graphic items and in order to avoid misalignments of the zero-based index when accessing the unique identification number of the graphic item through the GraphicItemUniqueIdGet method.

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 GraphicItemsTypeCountGet (

nType as enumGraphicItemType,

ByRef nCount as Int16

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes GraphicItemsTypeCountGet (

enumGraphicItemType nType,

ref Int16 nCount

);

[C++]

public: enumWanErrorCodes GraphicItemsTypeCountGet (

enumGraphicItemType nType,

Int16 __gc *nCount

);

Parameter

Description

nType

The type of graphic items.

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

nCount

Reference that, on return from the method call, will contain the total number of graphic items of the given type

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.