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]
Public Function GraphicItemBuddyTextGet (
nUniqueId as Int32,
ByRef strText as String,
ByRef fontText as Font
) as enumWanErrorCodes
|
|
[C#]
public enumWanErrorCodes GraphicItemBuddyTextGet (
Int32 nUniqueId,
ref string strText,
ref Font fontText
);
|
|
[C++]
public: enumWanErrorCodes GraphicItemBuddyTextGet (
Int32 nUniqueId,
string __gc *strText,
Font __gc *fontText
);
|
|
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:
|
strText
|
Reference that, on return from the method call, will contain the string of the buddy text.
An empty string will remove an eventually existing buddy text.
|
fontText
|
Reference that, on return from the method call, will contain the font used for rendering the text.
|
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.
|
|