Copyright © 2008-2013 MultiMedia Soft

GraphicItemDescriptionSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets 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 GraphicItemDescriptionSet (

nUniqueId as Int16,

strDescription as String

) as enumWanErrorCodes


 

[C#]

public enumWanErrorCodes GraphicItemDescriptionSet (

Int16 nUniqueId,

string strDescription

);


 

[C++]

public: enumWanErrorCodes GraphicItemDescriptionSet (

Int16 nUniqueId,

string strDescription

);


 

 

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

strDescription

String containing the description to assign to the graphic item

 

 

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.