Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 2.5 KB

getcurrentconsolefontex.md

File metadata and controls

79 lines (60 loc) · 2.5 KB
title description author ms.author ms.topic keywords f1_keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
GetCurrentConsoleFontEx function
See reference information about the GetCurrentConsoleFontEx function, which retrieves extended information about the currently used console font.
miniksa
miniksa
article
console, character mode applications, command line applications, terminal applications, console api
consoleapi3/GetCurrentConsoleFontEx
wincon/GetCurrentConsoleFontEx
GetCurrentConsoleFontEx
base.getcurrentconsolefontex
consoles.getcurrentconsolefontex
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
97d8e730-4110-4be5-b099-0acc1b6f8eb5
apiref
GetCurrentConsoleFontEx
Kernel32.dll
DllExport

GetCurrentConsoleFontEx function

[!INCLUDE not-recommended-banner]

Retrieves extended information about the current console font.

Syntax

BOOL WINAPI GetCurrentConsoleFontEx(
  _In_  HANDLE               hConsoleOutput,
  _In_  BOOL                 bMaximumWindow,
  _Out_ PCONSOLE_FONT_INFOEX lpConsoleCurrentFontEx
);

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.

lpConsoleCurrentFontEx [out]
A pointer to a CONSOLE_FONT_INFOEX 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.

[!INCLUDE no-vt-equiv-user-priv]

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header ConsoleApi3.h (via WinCon.h, include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See also

Console Functions

CONSOLE_FONT_INFOEX