setconsolehistoryinfo.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
SetConsoleHistoryInfo function	Sets the history settings for the Windows Console of the calling process.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi3/SetConsoleHistoryInfo wincon/SetConsoleHistoryInfo SetConsoleHistoryInfo	base.setconsolehistoryinfo consoles.setconsolehistoryinfo	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	db180f53-aa3c-4a91-bc3e-9f3f0bb7ab01	apiref	SetConsoleHistoryInfo	Kernel32.dll	DllExport

SetConsoleHistoryInfo function

[!INCLUDE not-recommended-banner]

Sets the history settings for the calling process's console.

Syntax

BOOL WINAPI SetConsoleHistoryInfo(
  _In_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Parameters

lpConsoleHistoryInfo [in]
A pointer to a CONSOLE_HISTORY_INFO structure that contains the history settings for the process's console.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the calling process is not a console process, the function fails and sets the last error code to ERROR_ACCESS_DENIED.

[!INCLUDE no-vt-equiv-shell-banner]

Requirements

Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	ConsoleApi3.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

See also

Console Functions

CONSOLE_HISTORY_INFO

GetConsoleHistoryInfo