Methods > Graphic items management > GraphicItemWaveRangeParamsGetEx method

Remarks

Obtains the value of one of the settings for the given wave range added to the waveform analyzer. Value of single settings can be modified through the GraphicItemWaveRangeParamsSetEx method.

This method is an alternative to the GraphicItemWaveRangeParamsGet method and is provided with the purpose of allowing single settings modifications when dealing with languages like JavaScript where data structures are not easy to implement.

Syntax

[Visual Basic]

control.GraphicItemWaveRangeParamsGetEx (

nUniqueId as Integer,

nParam as short

) as String

[C++]

BSTR control.GraphicItemWaveRangeParamsGetEx (

short nUniqueId,

short nParam

);

Parameter

Description

nUniqueId

Unique identification number assigned to the wave range by a previous call to the GraphicItemWaveRangeAdd method.

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value	Meaning
0	colorBack member of the WANALYZER_WAVE_RANGE data structure
1	colorWaveLinePeak member of the WANALYZER_WAVE_RANGE data structure
2	colorWaveLinePeak member of the WANALYZER_WAVE_RANGE data structure

Return value

Value

Meaning

Empty string

An error occurred: see the LastError property for further error details or for a list of the possible error values.

Valid string

String containing the value of the requested parameter.

The value is formatted with the following rules:

•	Color values are formatted like "#RRGGBB" where:

- "#" represents the control character used for formatting colors in HTML code: the presence of this character is mandatory

- RR represents the hexadecimal value of the color's red component

- GG represents the hexadecimal value of the color's green component

- BB represents the hexadecimal value of the color's blue component

For example the green color will be represented with the value "#00FF00"

•	Boolean values are rendered as

- "1" or "True" for indicating the boolean "true"

- "0" or "False" for indicating the boolean "false"