Share via

Função GetConsoleHistoryInfo

  • Artigo

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 as configurações de histórico do console do processo de chamada.

Sintaxe

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Parâmetros

lpConsoleHistoryInfo [out]
Um ponteiro para uma estrutura CONSOLE_HISTORY_INFO que recebe as configurações de histórico do console do processo de chamada.

Valor retornado

Se a função obtiver êxito, 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

Se o processo de chamada não for um processo de console, a função falhará e definirá o último erro como ERROR_ACCESS_DENIED.

Dica

Essa API não é recomendada e não tem um terminal virtual equivalente. Essa decisão alinha intencionalmente a plataforma Windows com outros sistemas operacionais em que o aplicativo cliente individual que atua como shell ou intérprete deve manter sua própria funcionalidade de conveniência do usuário, como leitura de linhas e comportamento de manipulação, incluindo aliases e histórico de comandos. 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 ConsoleApi3.h (via WinCon.h, inclui o Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções de Console

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo