Edit

CONSOLE_HISTORY_INFO structure

  • Article

Important

This document describes console platform functionality that is no longer a part of our ecosystem roadmap. We do not recommend using this content in new products, but we will continue to support existing usages for the indefinite future. Our preferred modern solution focuses on virtual terminal sequences for maximum compatibility in cross-platform scenarios. You can find more information about this design decision in our classic console vs. virtual terminal document.

Contains information about the console history.

Syntax

typedef struct {
  UINT  cbSize;
  UINT  HistoryBufferSize;
  UINT  NumberOfHistoryBuffers;
  DWORD dwFlags;
} CONSOLE_HISTORY_INFO, *PCONSOLE_HISTORY_INFO;

Members

cbSize
The size of the structure, in bytes. Set this member to sizeof(CONSOLE_HISTORY_INFO).

HistoryBufferSize
The number of commands kept in each history buffer.

NumberOfHistoryBuffers
The number of history buffers kept for this console process.

dwFlags
This parameter can be zero or the following value.

Value Meaning
HISTORY_NO_DUP_FLAG 0x1 Duplicate entries will not be stored in the history buffer.

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)

See also

GetConsoleHistoryInfo

SetConsoleHistoryInfo