Compartilhar via


Função GetConsoleOriginalTitle

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 original da janela do console atual.

Sintaxe

DWORD WINAPI GetConsoleOriginalTitle(
  _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 original.

nSize [in]
O tamanho do buffer de lpConsoleTitle em caracteres.

Valor retornado

Se nSize for zero, o valor retornado será zero.

Se a função for bem-sucedida, o valor retornado será o comprimento do título do console original, 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 atual, use a função GetConsoleTitle.

Para compilar um aplicativo que usa essa função, defina _WIN32_WINNT como 0x0600 ou posterior. Para obter mais informações, consulte Usar os cabeçalhos do Windows.

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.

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
Nomes Unicode e ANSI GetConsoleOriginalTitleW (Unicode) e GetConsoleOriginalTitleA (ANSI)

Confira também

Funções de Console

GetConsoleTitle

SetConsoleTitle