getconsolehistoryinfo.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
GetConsoleHistoryInfo function	See reference information about the GetConsoleHistoryInfo function, which retrieves the history settings for the console of the calling process.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi3/GetConsoleHistoryInfo wincon/GetConsoleHistoryInfo GetConsoleHistoryInfo	base.getconsolehistoryinfo consoles.getconsolehistoryinfo	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	145008b3-8a4a-4e6a-9144-ee787ce90ef4	apiref	GetConsoleHistoryInfo	Kernel32.dll	DllExport

GetConsoleHistoryInfo function

[!INCLUDE not-recommended-banner]

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

Syntax

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Parameters

lpConsoleHistoryInfo [out]
A pointer to a CONSOLE_HISTORY_INFO structure that receives the history settings for the calling 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 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

SetConsoleHistoryInfo