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.
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 GraphicItemDescriptionSet (
nUniqueId as Int16,
strDescription as String
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes GraphicItemDescriptionSet (
Int16 nUniqueId,
string strDescription
);
|
|
[C++]
public: enumErrorCodes 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:
|
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)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
