Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.GraphicItemBuddyTextParamsGet method

Remarks

Modifies parameters of a buddy text associated to a graphic item over the waveform's graphics. Settings for the buddy text can be modified through the WaveformAnalyzer.GraphicItemBuddyTextParamsSet method.

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

nUniqueId as Int32,

ByRef settings as WANALYZER_BUDDY_TEXT

) as enumErrorCodes

[C#]

public enumErrorCodes GraphicItemBuddyTextParamsGet (

Int32 nUniqueId,

ref WANALYZER_BUDDY_TEXT settings

);

[C++]

public: enumErrorCodes GraphicItemBuddyTextParamsGet (

Int32 nUniqueId,

WANALYZER_BUDDY_TEXT __gc *settings

);

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

settings

Reference that, on return from the method call, will contain the current settings.

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.