Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.ViewModeGet method

Remarks

Obtains the current visualization mode on the waveform analyzer. The visualization mode can be modified through the WaveformAnalyzer.ViewModeSet method.

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

ByRef nMode as enumWaveAnalyzerViewModes

) as enumErrorCodes

[C#]

public enumErrorCodes ViewModeGet (

ref enumWaveAnalyzerViewModes nMode

);

[C++]

public: enumErrorCodes ViewModeGet (

enumWaveAnalyzerViewModes __gc *nMode

);

Parameter

Description

nMode

Reference that, after returning from the method call, will contain the visualization mode.

Supported values are the following:

Mnemonic constant	Value	Meaning
WANALYZER_VIEW_MODE_WAVEFORM	0	Waveform view
WANALYZER_VIEW_MODE_SPECTRAL	1	Spectral view
WANALYZER_VIEW_MODE_WAVEFORM_ABS	2	Waveform view with absolute values

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