Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.SettingsRulersGet method

Remarks

Retrieves the rulers current settings for the waveform analyzer. Settings can be modified through the WaveformAnalyzer.SettingsRulersSet 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 SettingsRulersGet (

ByRef fontText as Font

[C#]

public enumErrorCodes SettingsRulersGet (

ref Font fontText

);

[C++]

public: enumErrorCodes SettingsRulersGet (

Font __gc *fontText

);

Parameter	Description

settings	Reference that, on return from the method call, will contain the rulers current settings.
fontText	Reference that, on return from the method call, will contain a copy of the font used for rendering the text of ruler's ticks. In order to avoid leaks of system resource, when the font is no more needed the container application should free it by calling the DeleteObject function of the Windows API.

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.