Export (0) Print
Expand All

GetCurrentConsoleFont function

Retrieves information about the current console font.

Syntax


BOOL WINAPI GetCurrentConsoleFont(
  _In_   HANDLE hConsoleOutput,
  _In_   BOOL bMaximumWindow,
  _Out_  PCONSOLE_FONT_INFO lpConsoleCurrentFont
);

Parameters

hConsoleOutput [in]

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

bMaximumWindow [in]

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

lpConsoleCurrentFont [out]

A pointer to a CONSOLE_FONT_INFO structure that receives the requested 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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Wincon.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions
Console Screen Buffers
CONSOLE_FONT_INFO
GetConsoleFontSize

 

 

Community Additions

ADD
Show:
© 2015 Microsoft