SetCurrentConsoleFontEx function (Windows)

Applies to: desktop apps only

Sets extended information about the current console font.

Syntax

BOOL WINAPI SetCurrentConsoleFontEx(
  __in  HANDLE hConsoleOutput,
  __in  BOOL bMaximumWindow,
  __in  PCONSOLE_FONT_INFOEX lpConsoleCurrentFontEx
);

Parameters

hConsoleOutput [in]

A handle to the console screen buffer. The handle must have the GENERIC_WRITE access right. For more information, see Console Buffer Security and Access Rights.

bMaximumWindow [in]

If this parameter is TRUE, font information is set for the maximum window size. If this parameter is FALSE, font information is set for the current window size.

lpConsoleCurrentFontEx [in]

A pointer to a CONSOLE_FONT_INFOEX structure that contains the font information.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.

Requirements

See also

Console Functions

CONSOLE_FONT_INFOEX

Send comments about this topic to Microsoft

Build date: 2/3/2012