Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.SettingsRulersGet method

Previous pageReturn to chapter overviewNext page

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 settings as WANALYZER_RULERS_SETTINGS,

ByRef fontText as Font

) as enumErrorCodes


 

[C#]

public enumErrorCodes SettingsRulersGet (

ref WANALYZER_RULERS_SETTINGS settings,

ref Font fontText

);


 

[C++]

public: enumErrorCodes SettingsRulersGet (

WANALYZER_RULERS_SETTINGS __gc *settings,

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.