Remarks
Retrieves the rulers current settings for the TracksBoard. Settings can be modified through the TracksBoard.SettingsRulersSet method.
For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.
For further details about methods of the TracksBoard refer to the TracksBoard object section.
Syntax
[Visual Basic]
control.TracksBoard.SettingsRulersGet (
ByRef settings as Long,
ByRef hFontText as OLE_HANDLE
) as enumErrorCodes
|
|
[C++]
short control.TracksBoard.SettingsRulersGet (
void *settings,
OLE_HANDLE *hFontText
);
|
|
Parameter
|
Description
|
|
|
settings
|
Address of a structure of type TRACKSBOARD_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)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
