Compartilhar via


Função SetConsoleScreenBufferInfoEx

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 informações estendidas sobre o buffer de tela do console especificado.

Sintaxe

BOOL WINAPI SetConsoleScreenBufferInfoEx(
  _In_ HANDLE                        hConsoleOutput,
  _In_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

Parâmetros

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

lpConsoleScreenBufferInfoEx [entrada]
Uma estrutura CONSOLE_SCREEN_BUFFER_INFOEX que contém as informações de buffer da tela do console.

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 tem um terminal virtual parcial equivalente. O Buffer de posicionamento do cursor e atributos de texto têm equivalentes de sequência específicos. A tabela de cores não é configurável, mas cores estendidas estão disponíveis além do que normalmente está disponível através das funções do console. Atributos pop-up não têm equivalente, pois menus pop-up são de responsabilidade do aplicativo cliente de linha de comando no mundo do terminal virtual. Finalmente, o tamanho da janela e o status da tela cheia são considerados privilégios de propriedade do usuário no mundo do terminal virtual e não têm sequência equivalente.

Requisitos

   
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [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

CONSOLE_SCREEN_BUFFER_INFOEX

GetConsoleScreenBufferInfoEx