Função SetConsoleCursorInfo

Artigo
12/15/2023

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 tamanho e a visibilidade do cursor para o buffer de tela do console especificado.

Sintaxe

BOOL WINAPI SetConsoleCursorInfo(
  _In_       HANDLE              hConsoleOutput,
  _In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);

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.

lpConsoleCursorInfo [entrada]
Um ponteiro para uma estrutura CONSOLE_CURSOR_INFO que fornece as novas especificações para o cursor do 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

Quando o cursor de um buffer de tela está visível, a aparência dele pode variar desde preencher completamente uma célula de caractere até aparecer como uma linha horizontal na parte inferior da célula. O membro dwSize da estrutura CONSOLE_CURSOR_INFO especifica a porcentagem de uma célula de caractere que é preenchida pelo cursor. Se esse membro for menor que 1 ou maior que 100, SetConsoleCursorInfo falhará.

Dica

Essa API tem um terminal virtual equivalente na seção de visibilidade do cursor com as sequências ^[[?25h e ^[[?25l.

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