Methods > Graphic items management > GraphicItemRemove method

Remarks

Removes the given 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 GraphicItemRemove (

nUniqueId as Int16

[C#]

public enumWanErrorCodes GraphicItemRemove (

Int16 nUniqueId

);

[C++]

public: enumWanErrorCodes GraphicItemRemove (

Int16 nUniqueId

);

Parameter

Description

nUniqueId

Unique identification number of the graphic item to remove.

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

Set this parameter to -1 in order to remove all of the available graphic items.

In order to remove all of the graphic items of a given type, use the GraphicItemsTypeRemove method.

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.