Methods > Graphic items management > GraphicItemBuddyPictureSetFromHandle method

Remarks

Sets a picture taken from a HBITMAP that will be displayed as a buddy picture of a graphic item over the waveform's graphics. The HBITMAP of the current buddy picture can be obtained through the GraphicItemBuddyPictureGet method.

Settings of the buddy picture can be obtained and modified through the GraphicItemBuddyPictureParamsGet and GraphicItemBuddyPictureParamsSet methods.

On the screenshot below you can see a set of vertical lines displayed over the waveform, each with its buddy picture aligned on the bottom right of the vertical line:

In this case vertical lines are set to be rendered over time rulers, allowing buddy pictures to be rendered outside of the waveform area.

An existing buddy picture can be removed at a later time by calling this method again with the HBITMAP parameter set to 0.

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

nUniqueId as Long,

hBitmap as OLE_HANDLE,

settings as Long

) as enumWanErrorCodes

[C++]

short control.GraphicItemBuddyPictureSetFromHandle (

long nUniqueId,

OLE_HANDLE hBitmap,

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

hBitmap

HBITMAP of the picture. If this parameter is set to 0 an eventually existing buddy picture will be removed.

settings

Address of a structure of type WANALYZER_BUDDY_PICTURE that contains the settings of the new buddy picture.

These settings can be modified or retrieved at a later time through the GraphicItemBuddyPictureParamsSet and GraphicItemBuddyPictureParamsGet methods.

By setting this value to 0 the buddy picture will be rendered with default setting.

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.