Share via

Функция GetConsoleHistoryInfo

  • Статья

Важно!

В этом документе описаны функции платформы консоли, которые больше не являются частью стратегии развития экосистемы. Мы не рекомендуем использовать это содержимое в новых продуктах, но мы будем продолжать поддерживать существующие использования для неопределенного будущего. Наше предпочтительное современное решение ориентировано на последовательности виртуальных терминалов для обеспечения максимальной совместимости в кроссплатформенных сценариях. Дополнительные сведения об этом решении по проектированию можно найти в классической консоли и в документе виртуального терминала .

Извлекает параметры журнала для консоли вызывающего процесса.

Синтаксис

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Параметры

lpConsoleHistoryInfo [out]
Указатель на CONSOLE_HISTORY_INFO структуру, которая получает параметры журнала для консоли вызывающего процесса.

Возвращаемое значение

Если функция завершается успешно, возвращаемое значение ненулевое.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Замечания

Если вызывающий процесс не является консольным процессом, функция завершается ошибкой и задает последнюю ошибку ERROR_ACCESS_DENIED.

Совет

Этот API не рекомендуется и не имеет эквивалента виртуального терминала . Это решение намеренно выравнивает платформу Windows с другими операционными системами, где отдельное клиентское приложение, выступающее в качестве оболочки или интерпретатора, должно поддерживать собственные функции удобства пользователя, такие как поведение чтения строк и манипуляций, включая псевдонимы и журнал команд. Удаленное взаимодействие приложений с помощью межплатформенных служебных программ и транспорта, таких как SSH, может не работать должным образом, если используется этот API.

Requirements

   
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Верхний колонтитул ConsoleApi3.h (через WinCon.h, включая Windows.h)
Библиотека Kernel32.lib
DLL-библиотеки Kernel32.dll

См. также

Функции консоли

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo