Copyright © 2013-2014 MultiMedia Soft

GraphicItemBuddyTextParamsGet method

Previous pageReturn to chapter overviewNext page

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 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.

 

 

Syntax

 

[Visual Basic]

control.GraphicItemBuddyTextParamsGet (

nUniqueId as Long,

ByRef settings as Long

) as enumWanErrorCodes


 

[C++]

short control.GraphicItemBuddyTextParamsGet (

long nUniqueId,

void *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:

GraphicItemHorizontalLineAdd for horizontal lines
GraphicItemVerticalLineAdd for vertical lines
GraphicItemWaveRangeAdd for wave ranges

settings

Address of a structure of type WANALYZER_BUDDY_TEXT that receives in output the current settings of the buddy 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.