Remarks
Adds a new vertical line that will be displayed over the waveform's graphics. This line can be manually moved on the screen through the mouse causing a WaveAnalyzerLineMoving event to be generated.
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.VerticalLineAdd (
nUniqueId as Integer,
nPosition as Long,
color as OLE_COLOR,
nMode as enumWaveformLineModes,
nWidth as Integer
) as enumErrorCodes
|
|
[C++]
short control.WaveformAnalyzer.VerticalLineAdd (
short nUniqueId,
long nPosition,
OLE_COLOR color,
short nMode,
short nWidth
);
|
|
Parameter
|
Description
|
|
|
nUniqueId
|
Unique identification number assigned to this new line. You can use your own set of identifiers.
It's recommended to avoid the usage of value -1 because it has internally a special and dedicated meaning.
|
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
|
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, check the LastError property value in order to get the error code
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful
|
|
