Copyright © 2006-2019 MultiMedia Soft

WaveformAnalyzer.GraphicItemVerticalLineParamsGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters of an existing vertical line displayed over the waveform's graphics. These parameters can be modified through the WaveformAnalyzer.GraphicItemVerticalLineParamsSet method.

 

For details about graphic items management on the waveform analyzer refer to the How to add graphic items to the Waveform analyzer section.

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 GraphicItemVerticalLineParamsGet (

nUniqueId as Int16,

ByRef settings as WANALYZER_VERTICAL_LINE

) as enumErrorCodes


 

[C#]

public enumErrorCodes GraphicItemVerticalLineParamsGet (

Int16 nUniqueId,

ref WANALYZER_VERTICAL_LINE settings

);


 

[C++]

public: enumErrorCodes GraphicItemVerticalLineParamsGet (

Int16 nUniqueId,

WANALYZER_VERTICAL_LINE __gc *settings

);


 

 

Parameter

Description

 

 

nUniqueId

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

settings

Reference that, on return from the method call, will contain the current settings.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.