Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.BitmapViewVerticalLineAdd method

Remarks

Adds a new vertical line that will be displayed when rendering the waveform's graphics through the WaveformAnalyzer.BitmapViewDrawToHdc method. This line can be removed at any time by using the WaveformAnalyzer.BitmapViewVerticalLineRemove method.

This method doesn't affect the waveform analyzer user interface but only the rendering of the waveform on a device context so it must not be confused with the WaveformAnalyzer.VerticalLineAdd method whose purpose is to add a vertical line on the waveform analyzer user interface.

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

Syntax

[Visual Basic]

Public Function BitmapViewVerticalLineAdd (

nUniqueId as Int16,

nPosition as Int32,

color as Color,

nMode as enumWaveformLineModes,

nWidth as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes BitmapViewVerticalLineAdd (

Int16 nUniqueId,

Int32 nPosition,

Color color,

enumWaveformLineModes nMode,

Int16 nWidth

);

[C++]

public: enumErrorCodes BitmapViewVerticalLineAdd (

Int16 nUniqueId,

Int32 nPosition,

Color color,

enumWaveformLineModes nMode,

Int16 nWidth

);

Parameter

Description

nUniqueId

Unique identification number assigned to this new line.

nPosition

Initial position expressed in milliseconds

color

Color of the line

nMode

Line mode used for rendering the line.

Supported values are the following:

Mnemonic constant	Numeric value	Meaning
LINE_MODE_DOTTED	0	Dotted line (applied only if the nWidth parameter below is set to 1)
LINE_MODE_DASHED	1	Dashed line (applied only if the nWidth parameter below is set to 1)
LINE_MODE_SOLID	2	Solid line

nWidth

Width of the line expressed in pixels. In case the parameter should be set to a value higher than 1, the nMode parameter above would be automatically set to LINE_MODE_SOLID.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.