Função GetConsoleTitle
Importante
Este documento descreve a funcionalidade da plataforma de console que não faz mais parte do nosso roteiro do 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.
Recupera o título da janela do console atual.
Sintaxe
DWORD WINAPI GetConsoleTitle(
_Out_ LPTSTR lpConsoleTitle,
_In_ DWORD nSize
);
Parâmetros
lpConsoleTitle [out]
Um ponteiro para um buffer que recebe uma cadeia de caracteres terminada em nulo contendo o título. Se o buffer for muito pequeno para armazenar o título, a função armazenará o máximo de caracteres que o buffer comportar, encerrando com um terminador nulo.
nSize [in]
O tamanho do buffer apontado pelo parâmetro lpConsoleTitle, em caracteres.
Valor retornado
Se a função for bem-sucedida, o valor retornado será o comprimento do título da janela do console, em caracteres.
Se a função falhar, o valor retornado será zero e GetLastError retornará o código de erro.
Comentários
Para definir o título de uma janela de console, use a função SetConsoleTitle. Para recuperar a cadeia de caracteres do título original, use a função GetConsoleOriginalTitle.
Essa função usa caracteres Unicode ou caracteres de 8 bits da página de código atual do console. O padrão da página de código do console inicialmente é a página de código OEM do sistema. Para alterar a página de código do console, use as funções SetConsoleCP ou SetConsoleOutputCP. Os consumidores herdados também podem usar os comandos chcp ou mode con cp select=, mas eles não são recomendados para novos desenvolvimentos.
Dica
Essa API não é recomendada e não tem um terminal virtual equivalente. Essa decisão alinha propositalmente a plataforma Windows com outros sistemas operacionais. A comunicação remota de aplicativos por meio de utilitários multiplataforma e transportes como SSH pode não funcionar como esperado se essa API é usada.
Exemplos
Para ver um exemplo, confira SetConsoleTitle.
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 |
| Nomes Unicode e ANSI | GetConsoleTitleW (Unicode) e GetConsoleTitleA (ANSI) |