Copyright © 2008-2013 MultiMedia Soft

GraphicItemNameSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the friendly name 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 GraphicItemNameSet (

nUniqueId as Int16,

strFriendlyName as String

) as enumWanErrorCodes


 

[C#]

public enumWanErrorCodes GraphicItemNameSet (

Int16 nUniqueId,

string strFriendlyName

);


 

[C++]

public: enumWanErrorCodes GraphicItemNameSet (

Int16 nUniqueId,

string strFriendlyName

);


 

 

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

strFriendlyName

String containing the friendly name 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.