Compartilhar via


Função SetConsoleDisplayMode

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.

Define o modo de exibição do buffer de tela do console especificado.

Sintaxe

BOOL WINAPI SetConsoleDisplayMode(
  _In_      HANDLE hConsoleOutput,
  _In_      DWORD  dwFlags,
  _Out_opt_ PCOORD lpNewScreenBufferDimensions
);

Parâmetros

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

dwFlags [in]
O modo de exibição do console. Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
CONSOLE_FULLSCREEN_MODE 1 O texto é exibido no modo de tela inteira.
CONSOLE_WINDOWED_MODE 2 O texto é exibido em uma janela do console.

lpNewScreenBufferDimensions [saída, opcional]
Um ponteiro para uma estrutura COORD que recebe as novas dimensões do buffer de tela, em caracteres.

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

Modos de console

GetConsoleDisplayMode