|
WaveformAnalyzer.GraphicItemBuddyTextGet method |
  
|
|
WaveformAnalyzer.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.
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 GraphicItemBuddyTextGet ( nUniqueId as Int32, ByRef strText as String, ByRef fontText as Font ) as enumErrorCodes |
[C#] public enumErrorCodes GraphicItemBuddyTextGet ( Int32 nUniqueId, ref string strText, ref Font fontText ); |
[C++] public: enumErrorCodes 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) |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |
When used through COM interoperability, this method has a slightly different syntax:
Syntax
[Visual Basic 6] GraphicItemBuddyTextGet ( nUniqueId as Long, ByRef hFontText as OLE_HANDLE ) as String |
[Unmanaged Visual C++] LPCTSTR 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:
|
||||||
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 |
