Methods > Settings > SettingsWaveParamGet method

Remarks

Retrieves one of the current waveform rendering settings for the waveform analyzer. Single settings can be modified through the SettingsWaveParamSet method.

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

Syntax

[Visual Basic]

control.SettingsWaveParamGet (

nParam as short

) as String

[C++]

BSTR control.SettingsWaveParamGet (

short nParam

);

Parameter

Description

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value	Meaning
0	nStereoVisualizationMode member of the WANALYZER_WAVEFORM_SETTINGS data structure
1	colorWaveLinePeak member of the WANALYZER_WAVEFORM_SETTINGS data structure
2	colorWaveLineCenter member of the WANALYZER_WAVEFORM_SETTINGS data structure
3	nWaveLineIntensityFactor member of the WANALYZER_WAVEFORM_SETTINGS data structure
4	colorWaveBackground member of the WANALYZER_WAVEFORM_SETTINGS data structure
5	bUseHalfColorsForPeaks member of the WANALYZER_WAVEFORM_SETTINGS data structure
6	nSelectionMode member of the WANALYZER_WAVEFORM_SETTINGS data structure
7	colorWaveLineSelPeak member of the WANALYZER_WAVEFORM_SETTINGS data structure
8	colorWaveLineSelCenter member of the WANALYZER_WAVEFORM_SETTINGS data structure
9	colorWaveSelBackground member of the WANALYZER_WAVEFORM_SETTINGS data structure
10	colorTransparentGlass member of the WANALYZER_WAVEFORM_SETTINGS data structure
11	nTransparentGlassFactor member of the WANALYZER_WAVEFORM_SETTINGS data structure
12	colorVolumeLevelLine member of the WANALYZER_WAVEFORM_SETTINGS data structure
13	colorTimeLine member of the WANALYZER_WAVEFORM_SETTINGS data structure
14	nTransparentGlassType member of the WANALYZER_WAVEFORM_SETTINGS data structure
15	nTransparentGlassPos3D member of the WANALYZER_WAVEFORM_SETTINGS data structure
16	bTransparentGlassInvert3D member of the WANALYZER_WAVEFORM_SETTINGS data structure
17	bDrawLinesOverWave member of the WANALYZER_WAVEFORM_SETTINGS 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"