Classes > SpectrumEnh class > Methods > SpectrumEnh.SettingsGeneralGet method

Remarks

Retrieves the current general settings for the enhanced spectrum analyzer of the given player. Settings can be modified through the SpectrumEnh.SettingsGeneralSet 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.

For details about using other embedded Visual Feedbacks refer to the How to use the embedded Visual Feedbacks section

Syntax

[Visual Basic]

Public Function SettingsGeneralGet (

nPlayerIndex as Int16,

ByRef settings as SPECTR_ENH_GENERAL_SETTINGS

) as enumErrorCodes

[C#]

public enumErrorCodes SettingsGeneralGet (

Int16 nPlayerIndex,

ref SPECTR_ENH_GENERAL_SETTINGS settings

);

[C++]

public: enumErrorCodes SettingsGeneralGet (

Int16 nPlayerIndex,

SPECTR_ENH_GENERAL_SETTINGS __gc *settings

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the spectrum analyzer
settings	Reference that, on return from the method call, will contain the current general 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.