Funzione GetConsoleHistoryInfo

  • Articolo

Importante

Questo documento descrive le funzionalità della piattaforma della console che non fanno più parte della roadmap dell'ecosistema. Non è consigliabile usare questo contenuto nei nuovi prodotti, ma continueremo a supportare gli utilizzi esistenti per il futuro indefinito. La soluzione moderna preferita è incentrata sulle sequenze di terminale virtuale per garantire la massima compatibilità negli scenari multipiattaforma. Per altre informazioni su questa decisione di progettazione, vedere il documento relativo alla console classica e al terminale virtuale.

Recupera le impostazioni della cronologia per la console del processo chiamante.

Sintassi

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Parametri

lpConsoleHistoryInfo [out]
Puntatore a una struttura CONSOLE_HISTORY_INFO che riceve le impostazioni di cronologia per la console del processo chiamante.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Osservazioni:

Se il processo chiamante non è un processo della console, la funzione ha esito negativo e imposta l'ultimo errore su ERROR_ACCESS_DENIED.

Suggerimento

Questa API non è consigliata e non ha un terminale virtuale equivalente. Questa decisione allinea intenzionalmente la piattaforma Windows ad altri sistemi operativi in cui l'applicazione client singola che funge da shell o interprete deve mantenere le proprie funzionalità di praticità utente, ad esempio la lettura e il comportamento di manipolazione delle righe, inclusi alias e cronologia dei comandi. Le applicazioni remote tramite utilità multipiattaforma e trasporti come SSH potrebbero non funzionare come previsto se si usa questa API.

Requisiti

   
Client minimo supportato Windows Vista [solo app desktop]
Server minimo supportato Windows Server 2008 [solo app desktop]
Intestazione ConsoleApi3.h (tramite WinCon.h, includere Windows.h)
Libreria Kernel32.lib
DLL Kernel32.dll

Vedi anche

Funzioni della console

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo