Copyright © 2013-2014 MultiMedia Soft

GraphicItemHorizontalLineParamsGetEx method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains one of the settings for the given horizontal line added to the waveform analyzer. Value of single settings can be modified through the GraphicItemHorizontalLineParamsSetEx method.

This method is an alternative to the GraphicItemHorizontalLineParamsGet 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.GraphicItemHorizontalLineParamsGetEx (

nUniqueId as Integer,

nParam as short

) as String


 

[C++]

BSTR control.GraphicItemHorizontalLineParamsGetEx (

short nUniqueId,

short nParam

);


 

Parameter

Description

 

 

nUniqueId

Unique identification number assigned to the line by a previous call to the GraphicItemHorizontalLineAdd method.

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value

Meaning

0

color member of the WANALYZER_HORIZONTAL_LINE data structure

1

nChannel member of the WANALYZER_HORIZONTAL_LINE data structure

2

nDashStyle member of the WANALYZER_HORIZONTAL_LINE data structure

3

nHeightInPix member of the WANALYZER_HORIZONTAL_LINE data structure

4

nTranspFactor member of the WANALYZER_HORIZONTAL_LINE data structure

5

nVertPosInPerc member of the WANALYZER_HORIZONTAL_LINE data structure

6

nLeftCap member of the WANALYZER_HORIZONTAL_LINE data structure

7

nRightCap member of the WANALYZER_HORIZONTAL_LINE data structure

8

nDashCap member of the WANALYZER_HORIZONTAL_LINE 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"