Copyright © 2013-2014 MultiMedia Soft

SettingsRulersGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Retrieves the rulers current settings for the waveform analyzer. Settings can be modified through the SettingsRulersSet method.

 

 

Syntax

 

[Visual Basic]

control.SettingsRulersGet (

settings as Long,

hFontText as OLE_HANDLE

) as enumWanErrorCodes


 

[C++]

short control.SettingsRulersGet (

void *settings,

OLE_HANDLE *hFontText

);


 

 

Parameter

Description

 

 

settings

Address of a structure of type WANALYZER_RULERS_SETTINGS that, on return from the method call, will contain the rulers current settings.

hFontText

Reference that, on return from the method call, will contain the handle to 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)

enumWanErrorCodes.ERR_WAN_NOERROR (0)

The method call was successful.