Compartilhar via


Função GetLargestConsoleWindowSize

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 maior janela de console possível, com base na fonte atual e no tamanho da exibição.

Sintaxe

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

Parâmetros

hConsoleOutput [in]
Um identificador do buffer da tela do console.

Valor retornado

Se a função for bem-sucedida, o valor retornado será uma estrutura COORD que especifica o número de colunas de célula de caractere (membro X) e de linhas (membro Y) na maior janela de console possível. Caso contrário, os membros da estrutura serão zero.

Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função não leva em consideração o tamanho do buffer de tela do console, o que significa que o tamanho da janela retornada pode ser maior do que o tamanho do buffer de tela do console. A função GetConsoleScreenBufferInfo pode ser usada para determinar o tamanho máximo da janela do console, considerando o tamanho atual do buffer de tela, a fonte atual e o tamanho de exibição.

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 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho ConsoleApi2.h (via WinCon.h, inclui o Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções de Console

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo

Tamanho do buffer da janela e da tela