Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.GraphicItemWaveRangeParamsGet method

Remarks

Obtains settings of an existing wave range displayed over the waveform's graphics. These settings can be modified through the WaveformAnalyzer.GraphicItemWaveRangeParamsSet method.

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

nUniqueId as Int16,

[C#]

public enumErrorCodes GraphicItemWaveRangeParamsGet (

Int16 nUniqueId,

);

[C++]

public: enumErrorCodes GraphicItemWaveRangeParamsGet (

Int16 nUniqueId,

);

Parameter	Description

nUniqueId	Unique identification number assigned to the wave range by a previous call to the WaveformAnalyzer.GraphicItemWaveRangeAdd method.
settings	Reference that, on return from the method call, will contain the current settings.

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.