Compartilhar via


Função GetConsoleFontSize

Importante

Este documento descreve a funcionalidade da plataforma de console que não faz mais parte do nosso roteiro do ecossistema. Não recomendamos o uso desse conteúdo em novos produtos, mas continuaremos a oferecer suporte aos usos existentes por tempo indeterminado. Nossa solução moderna preferida se concentra em sequências de terminais virtuais para máxima compatibilidade em cenários de multiplataforma. Você pode encontrar mais informações sobre essa decisão de design em nosso documento Console clássico versus terminal virtual.

Recupera o tamanho da fonte usada pelo buffer de tela do console especificado.

Sintaxe

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

Parâmetros

hConsoleOutput [in]
Um identificador do buffer da tela do console. O identificador deve ter o direito de acesso GENERIC_READ. Para saber mais, confira Segurança de buffer e direitos de acesso do console.

nFont [in]
O índice da fonte cujo tamanho deve ser recuperado. Esse índice é obtido com a chamada da função GetCurrentConsoleFont.

Valor retornado

Se a função for bem-sucedida, o valor retornado será uma estrutura COORD contendo a largura e a altura da cadeia de caracteres na fonte em unidades lógicas. O membro X contém a largura, enquanto o membro Y contém a altura.

Quando a função falha, a largura e a altura é zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Para compilar aplicativos que usam essa função, defina _WIN32_WINNT como 0x0500 ou posterior. Para obter mais informações, consulte Usar os cabeçalhos do Windows.

Dica

Essa API não é recomendada e não tem um terminal virtual equivalente. Essa decisão alinha intencionalmente a plataforma Windows com outros sistemas operacionais nos quais o usuário tem controle total sobre essa opção de apresentação. A comunicação remota de aplicativos por meio de utilitários multiplataforma e transportes como SSH pode não funcionar como esperado se essa API é usada.

Requisitos

   
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Cabeçalho ConsoleApi3.h (via WinCon.h, inclui o Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções de Console

Buffers da tela do console

COORD

GetCurrentConsoleFont