Copyright © 2008-2018 MultiMedia Soft

WaveformAnalyzer.SettingsRulersParamGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves one of the current rulers settings for the waveform analyzer. Single settings can be modified through the WaveformAnalyzer.SettingsRulersParamSet method.

This method is an alternative to the WaveformAnalyzer.SettingsRulersGet 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.

 

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 object section.

 

 

Syntax

 

[Visual Basic]

control.WaveformAnalyzer.SettingsRulersParamGet (

nParam as short

) as String


 

[C++]

BSTR control.WaveformAnalyzer.SettingsRulersParamGet (

short nParam

);


 

 

 

Parameter

Description

 

 

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value

Meaning

0

nAmplitudeScale member of the WANALYZER_RULERS_SETTINGS data structure

1

bVisibleLeft member of the WANALYZER_RULERS_SETTINGS data structure

2

bTicksLeft member of the WANALYZER_RULERS_SETTINGS data structure

3

bVisibleRight member of the WANALYZER_RULERS_SETTINGS data structure

4

bTicksRight member of the WANALYZER_RULERS_SETTINGS data structure

5

bVisibleTop member of the WANALYZER_RULERS_SETTINGS data structure

6

bTicksTop member of the WANALYZER_RULERS_SETTINGS data structure

7

bVisibleBottom member of the WANALYZER_RULERS_SETTINGS data structure

8

bTicksBottom member of the WANALYZER_RULERS_SETTINGS data structure

9

colorBackground member of the WANALYZER_RULERS_SETTINGS data structure

10

colorTicks member of the WANALYZER_RULERS_SETTINGS data structure

11

colorText member of the WANALYZER_RULERS_SETTINGS data structure

12

nTopRulerHeightInPix member of the WANALYZER_RULERS_SETTINGS data structure

13

nBottomRulerHeightInPix member of the WANALYZER_RULERS_SETTINGS data structure

14

nVertRulerWidthInPix member of the WANALYZER_RULERS_SETTINGS data structure

15

fTimeTicksFrequencyInPix member of the WANALYZER_RULERS_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"