Copyright © 2008-2019 MultiMedia Soft

WaveformAnalyzer.GraphicItemRemove method

Previous pageReturn to chapter overviewNext page

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.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

 

 

Syntax

 

[Visual Basic]

Public Function GraphicItemRemove (

nUniqueId as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes GraphicItemRemove (

Int16 nUniqueId

);


 

[C++]

public: enumErrorCodes 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:

 

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 WaveformAnalyzer.GraphicItemsTypeRemove method.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.