Función GetConsoleFontSize

Importante

En este documento se describe la funcionalidad de la plataforma de consola que ya no forma parte de nuestra hoja de ruta del ecosistema. No se recomienda usar este contenido en nuevos productos, pero seguiremos admitiendo los usos existentes para un futuro indefinido. Nuestra solución moderna preferida se centra en secuencias de terminal virtual para lograr la máxima compatibilidad en escenarios multiplataforma. Puede encontrar más información sobre esta decisión de diseño en nuestro documento de la consola clásica frente al terminal virtual.

Recupera el tamaño del tipo de letra utilizado por el búfer de pantalla de la consola especificado.

Sintaxis

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

Parámetros

hConsoleOutput [in]
Identificador del búfer de pantalla de la consola. El identificador debe tener derecho de acceso de GENERIC_READ. Para obtener más información, consulte Seguridad y derechos de acceso del búfer de la consola.

nFont [in]
Índice del tipo de letra cuyo tamaño se va a recuperar. Este índice se obtiene llamando a la función GetCurrentConsoleFont.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es una estructura COORD que contiene el ancho y el alto de cada carácter del tipo de letra en unidades lógicas. El miembro X contiene el ancho, mientras que el miembro Y contiene el alto.

Si se produce un error en la función, el ancho y el alto son cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Para compilar una aplicación que use esta función, defina _WIN32_WINNT como 0x0500 o posterior. Para obtener más información, consulte Uso de los encabezados de Windows.

Sugerencia

Esta API no se recomienda y no tiene un equivalente de terminal virtual. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos en los que se concede al usuario control total sobre esta opción de presentación. Es posible que las aplicaciones que se comuniquen de forma remota a través de utilidades y transportes multiplataforma como SSH no funcionen como se espera si se utiliza esta API.

Requisitos

Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado	ConsoleApi3.h (a través de WinCon.h, incluido Windows.h)
Biblioteca	Kernel32.lib
Archivo DLL	Kernel32.dll

Consulte también

Funciones de la consola

Búferes de pantalla de la consola

COORD

GetCurrentConsoleFont