| title | description | author | ms.author | ms.topic | keywords | f1_keywords | MS-HAID | MSHAttr | ms.assetid | topic_type | api_name | api_location | api_type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GetConsoleFontSize function |
Retrieves the size of the font used by the specified console screen buffer. |
miniksa |
miniksa |
article |
console, character mode applications, command line applications, terminal applications, console api |
|
|
|
51b1f58d-b3fb-4e09-8398-671b3959bb01 |
|
|
|
|
[!INCLUDE not-recommended-banner]
Retrieves the size of the font used by the specified console screen buffer.
COORD WINAPI GetConsoleFontSize(
_In_ HANDLE hConsoleOutput,
_In_ DWORD nFont
);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.
nFont [in]
The index of the font whose size is to be retrieved. This index is obtained by calling the GetCurrentConsoleFont function.
If the function succeeds, the return value is a COORD structure that contains the width and height of each character in the font, in logical units. The X member contains the width, while the Y member contains the height.
If the function fails, the width and the height are zero. To get extended error information, call GetLastError.
To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.
[!INCLUDE no-vt-equiv-user-priv]
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Header | ConsoleApi3.h (via WinCon.h, include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |