COM Objects > WaveformAnalyzer object > Methods > WaveformAnalyzer.GraphicItemDescriptionSet method

Remarks

Sets the description of 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 object section.

Syntax

[Visual Basic]

control.WaveformAnalyzer.GraphicItemDescriptionSet (

nUniqueId as Integer,

strDescription as String

[C++]

short control.WaveformAnalyzer.GraphicItemDescriptionSet (

short nUniqueId,

LPCTSTR strDescription

);

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:

•	WaveformAnalyzer.GraphicItemHorizontalLineAdd for horizontal lines

•	WaveformAnalyzer.GraphicItemVerticalLineAdd for vertical lines

•	WaveformAnalyzer.GraphicItemWaveRangeAdd for wave ranges

strDescription

String containing the description to assign to the graphic item

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.