GetConsoleHistoryInfo function

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.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wincon.h

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo