Methods > Graphic items management > GraphicItemWaveRangeParamsGet method

Remarks

Obtains settings of an existing wave range displayed over the waveform's graphics. These settings can be modified through the 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.

Syntax

[Visual Basic]

Public Function GraphicItemWaveRangeParamsGet (

nUniqueId as Int16,

ByRef settings as WANALYZER_WAVE_RANGE

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes GraphicItemWaveRangeParamsGet (

Int16 nUniqueId,

ref WANALYZER_WAVE_RANGE settings

);

[C++]

public: enumWanErrorCodes GraphicItemWaveRangeParamsGet (

Int16 nUniqueId,

WANALYZER_WAVE_RANGE __gc *settings

);

Parameter	Description

nUniqueId	Unique identification number assigned to the wave range by a previous call to the 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)
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful.