SettingsRulersGet method |
|
Remarks
Retrieves the rulers current settings for the waveform analyzer. Settings can be modified through the SettingsRulersSet method.
Syntax
[Visual Basic] Public Function SettingsRulersGet ( ByRef settings as WANALYZER_RULERS_SETTINGS, ByRef fontText as Font ) as enumWanErrorCodes |
[C#] public enumWanErrorCodes SettingsRulersGet ( ref WANALYZER_RULERS_SETTINGS settings, ref Font fontText ); |
[C++] public: enumWanErrorCodes 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) |
enumWanErrorCodes.ERR_WAN_NOERROR (0) |
The method call was successful. |