Classes > SpectrumEnh class > Methods > SpectrumEnh.SettingsGeneralSet method

Remarks

Sets new general settings for the waveform analyzer. Current settings can be obtained through the SpectrumEnh.SettingsGeneralGet 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 SettingsGeneralSet (

nPlayerIndex as Int16,

[C#]

public enumErrorCodes SettingsGeneralSet (

Int16 nPlayerIndex,

);

[C++]

public: enumErrorCodes SettingsGeneralSet (

Int16 nPlayerIndex,

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the player that will use the spectrum analyzer
settings	The new 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.