Copyright © 2008-2013 MultiMedia Soft

GraphicItemDescriptionGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the description of the given graphic item.

 

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

nUniqueId as Int32

) as string


 

[C#]

public string GraphicItemDescriptionGet (

Int32 nUniqueId

);


 

[C++]

public: string GraphicItemDescriptionGet (

Int32 nUniqueId

);


 

 

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

 

Return value

 

Value

Meaning

 

 

Empty string

Information not available or an error occurred (see the LastError property for further error details)

Valid string

The description of the graphic item