Export (0) Print
Expand All

GetConsoleFontSize function

Retrieves the size of the font used by the specified console screen buffer.

Syntax


COORD WINAPI GetConsoleFontSize(
  _In_  HANDLE hConsoleOutput,
  _In_  DWORD nFont
);

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.

nFont [in]

The index of the font whose size is to be retrieved. This index is obtained by calling the GetCurrentConsoleFont function.

Return value

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.

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
COORD
GetCurrentConsoleFont

 

 

Community Additions

ADD
Show:
© 2014 Microsoft