NAME

GetDiskFontCtrl: Inquire diskfont global settings. (V45)

SYNOPSIS

value = GetDiskFontCtrl( tagid );

LONG GetDiskFontCtrl( LONG tagitem );

FUNCTION

GetDiskFontCtrl reads global settings of the diskfont library, as the setting of the base DPI X and Y values, the cache enable flag and the AvailFonts sorting values. The TagItem passed in identifies the type of data item to read.

INPUTS

tagid: a tag ID as documented in diskfont/diskfonttag.h that identifies the kind of data item to inquiry.

The following tag values are currently supported: (see diskfont/diskfonttag.h)

Font generator DPI settings:

DFCTRL_XDPI DFCTRL_YDPI X and Y dpi device resolution

DFCTRL_XDOTP DFCTRL_YDOTP X and Y dpi dot sizes.

DFCTRL_CACHE AvailFonts cache enable (BOOL)

DFCTRL_SORTMODE AvailFonts font sorting (LONG)

currently defined sort orders are:

DFCTRL_SORT_OFF don't sort DFCTRL_SORT_ASC localized ascending DFCTRL_SORT_DES localized descending

RESULT

value: The current diskfont default setting for the selected tag item. The result code is undocumented if an unknown tag value is passed in.

EXAMPLE

BOOL cache;

cache = GetDiskFontCtrl(DFCTRL_CACHE);

/* read the current cache enable flag. */

NOTES

This call is not semaphore protected. This means that several calls to this function and SetDiskFontCtrl() might cause inconsistent results. The function will not fail or crash, but the result might be near to useless in a multitasking system. This function should never be called by the average user. Its sole purpose is to provide the font preferences editor with data about the current diskfont settings. It should not be called for other purposes.