Classes > SpectrumEnh class > Methods > SpectrumEnh.SettingsRulersGet method

Remarks

Retrieves the current settings for the rulers of the enhanced spectrum analyzer. Settings can be modified through the SpectrumEnh.SettingsRulersSet method.

For further details about using the Enhanced Spectrum Analyzer refer to the SpectrumEnh section.

For details about using the Enhanced Spectrum Analyzer refer to the How to use the Enhanced Spectrum Analyzer tutorial.

Syntax

[Visual Basic]

Public Function SettingsRulersGet (

ByRef settings as SPECTR_ENH_RULERS_SETTINGS

) as enumErrorCodes

[C#]

public enumErrorCodes SettingsRulersGet (

ref SPECTR_ENH_RULERS_SETTINGS settings

);

[C++]

public: enumErrorCodes SettingsRulersGet (

SPECTR_ENH_RULERS_SETTINGS __gc *settings

);

Parameter	Description

settings	Reference that, on return from the method call, will contain the current rulers 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.