Fonction SetConsoleHistoryInfo

Important

Ce document décrit les fonctionnalités de la plateforme de console qui ne font plus partie de notre feuille de route de l’écosystème. Nous vous déconseillons d’utiliser ce contenu dans de nouveaux produits, mais nous continuerons prendre en charge des utilisations existantes pour l’avenir indéterminé. Notre solution moderne préférée se concentre sur les séquences de terminal virtuel pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document console classique versus terminal virtuel.

Définit les paramètres d’historique de la console du processus appelant.

Syntaxe

BOOL WINAPI SetConsoleHistoryInfo(
  _In_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Paramètres

lpConsoleHistoryInfo [entrée]
Un pointeur vers une structure CONSOLE_HISTORY_INFO qui contient les paramètres d’historique pour la console du processus.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Notes

Si le processus appelant n’est pas un processus de console, la fonction échoue et définit le dernier code d’erreur sur ERROR_ACCESS_DENIED.

Conseil

Cette API n’est pas recommandée et n’a pas d’équivalent au terminal virtuel. Cette décision aligne intentionnellement la plateforme Windows avec d’autres systèmes d’exploitation où l’application cliente individuelle agissant en tant que shell ou interpréteur est censée maintenir ses propres fonctionnalités pratiques pour l’utilisateur, telles que la lecture de lignes et le comportement de manipulation, y compris les alias et l’historique des commandes. Le remoting des applications via des utilitaires multiplateformes et des transports comme SSH peut ne pas fonctionner comme prévu si vous utilisez cette API.

Spécifications

Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
En-tête	ConsoleApi3.h (via WinCon.h, inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll

Voir aussi

Fonctions de console

CONSOLE_HISTORY_INFO

GetConsoleHistoryInfo