Função GetConsoleScreenBufferInfo
Recupera informações sobre o buffer de tela do console especificado.
Sintaxe
BOOL WINAPI GetConsoleScreenBufferInfo(
_In_ HANDLE hConsoleOutput,
_Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);
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.
lpConsoleScreenBufferInfo [out]
Um ponteiro para uma estrutura CONSOLE_SCREEN_BUFFER_INFO que recebe 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
O retângulo retornado no membro srWindow da estrutura CONSOLE_SCREEN_BUFFER_INFO 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_INFO 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.
Exemplos
Para obter um exemplo, consulte Rolagem pela janela de um buffer de tela.
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 |