Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.GraphicItemBuddyPictureSetFromFile method

Remarks

Sets a picture taken from a file 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 WaveformAnalyzer.GraphicItemBuddyPictureGet method.

Settings of the buddy picture can be obtained and modified through the WaveformAnalyzer.GraphicItemBuddyPictureParamsGet and WaveformAnalyzer.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 and by specifying an empty pathname.

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 GraphicItemBuddyPictureSetFromFile (

nUniqueId as Int32,

strPathname as String,

settings as WANALYZER_BUDDY_PICTURE

) as enumErrorCodes

[C#]

public enumErrorCodes GraphicItemBuddyPictureSetFromFile (

Int32 nUniqueId,

string strPathname,

WANALYZER_BUDDY_PICTURE settings

);

[C++]

public: enumErrorCodes GraphicItemBuddyPictureSetFromFile (

Int32 nUniqueId,

string strPathname,

WANALYZER_BUDDY_PICTURE 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:

•	WaveformAnalyzer.GraphicItemHorizontalLineAdd for horizontal lines

•	WaveformAnalyzer.GraphicItemVerticalLineAdd for vertical lines

•	WaveformAnalyzer.GraphicItemWaveRangeAdd for wave ranges

strPathname

Absolute pathname of the picture file.

Supported graphic formats are BMP, ICO, GIF, JPG, TIF and PNG.

An empty string will remove an eventually existing buddy picture.

settings

Settings for the buddy picture.

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

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.