Methods > Graphic items management > GraphicItemBuddyTextGet method

Remarks

Obtains the buddy text of a graphic item over the waveform's graphics.

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]

control.GraphicItemBuddyTextGet (

nUniqueId as Long,

ByRef hFontText as OLE_HANDLE

) as String

[C++]

LPCTSTR control.GraphicItemBuddyTextGet (

long nUniqueId,

OLE_HANDLE *hFontText

);

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:

•	GraphicItemHorizontalLineAdd for horizontal lines

•	GraphicItemVerticalLineAdd for vertical lines

•	GraphicItemWaveRangeAdd for wave ranges

hFontText

Reference that, on return from the method call, will contain the handle (HFONT) of the font used for rendering the text.

In order to avoid leaks of system resource, when the font is no more needed the container application should free it by calling the DeleteObject function of the Windows API.

Return value

Value	Meaning

Empty string	Information not available or an error occurred (see the LastError property for further error details)
Valid string	The string of the buddy text