Compartilhar via


Função GetConsoleScreenBufferInfoEx

Recupera informações estendidas sobre o buffer de tela do console especificado.

Sintaxe

BOOL WINAPI GetConsoleScreenBufferInfoEx(
  _In_  HANDLE                        hConsoleOutput,
  _Out_ 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_READ. Para saber mais, confira Segurança de buffer e direitos de acesso do console.

lpConsoleScreenBufferInfoEx [out]
Uma estrutura CONSOLE_SCREEN_BUFFER_INFOEX que recebe as informações solicitadas de buffer de 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

O retângulo retornado no membro srWindow da estrutura CONSOLE_SCREEN_BUFFER_INFOEX pode ser modificado e, em seguida, passado para a função SetConsoleWindowInfo para rolar o buffer de tela do console na janela e alterar o tamanho da janela ou ambos.

Todas as coordenadas retornadas na estrutura CONSOLE_SCREEN_BUFFER_INFOEX estão em coordenadas de célula de caractere, em que a origem (0, 0) está no canto superior esquerdo do buffer da tela do console.

Dica

Essa API não tem um terminal virtual equivalente. Seu uso ainda pode ser necessário para aplicativos que tentam desenhar colunas, grades ou preencher a exibição para recuperar o tamanho da janela. Esse estado de janela é gerenciado pelo TTY/PTY/Pseudoconsole fora do fluxo de stream normal e geralmente é considerado um privilégio de usuário não ajustável pelo aplicativo cliente. As atualizações podem ser recebidas em ReadConsoleInput.

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

SetConsoleScreenBufferInfoEx