Compartilhar via


Função SetConsoleScreenBufferSize

Importante

Este documento descreve a funcionalidade da plataforma do console que não faz mais parte do nosso roteiro de 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.

Altera o tamanho do buffer da tela do console especificado.

Sintaxe

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

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.

dwSize [entrada]
Uma estrutura COORD que especifica o novo tamanho do buffer de tela do console em linhas e colunas de caracteres. A largura e a altura especificadas não podem ser menores que a largura e a altura da janela do buffer da tela do console. As dimensões especificadas também não podem ser menores que o tamanho mínimo permitido pelo sistema. Esse mínimo depende do tamanho da fonte atual do console (selecionado pelo usuário) e dos valores SM_CXMIN e SM_CYMIN retornados pela função GetSystemMetrics.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Dica

Essa API não é recomendada e não tem um equivalente de terminal virtual. 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 estiver usando essa API.

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

Buffer de entrada do console

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo