SIMPOL Documentation

wxsystemfont()

Description

Retrieves the system default font corresponding to the type requested. Returns either a wxfont object or .nul, whereby this would not necessarily be an error. The error parameter should be checked if an error is suspected.

Prototype

wxsystemfont ( string font, integer error )

Parameters

ParameterDefault valueType nameDescription
font"system"string Specifies which default font is desired. This can be any of: "oem-fixed", "ansi-fixed", "ansi-variable", "system", "default-device", or "default-gui".
error.nulinteger Specifies an object which is used to output any error code generated during the execution of the function. If error is not specified or is .nul then any error which occurs during function execution will halt the program. If an error object is specified and an error occurs during function execution then the error code is output into that object and the methods returns .nul.