Функция SetConsoleScreenBufferInfoEx

  • Статья

Важно!

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

Задает расширенные сведения о указанном буфере экрана консоли.

Синтаксис

BOOL WINAPI SetConsoleScreenBufferInfoEx(
  _In_ HANDLE                        hConsoleOutput,
  _In_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

Параметры

hConsoleOutput [ввод]
Дескриптор буфера экрана консоли. У дескриптора должно быть право на доступ GENERIC_WRITE. Дополнительные сведения см. в статье Безопасность и права доступа для буфера консоли.

lpConsoleScreenBufferInfoEx [in]
Структура CONSOLE_SCREEN_BUFFER_INFOEX , содержащая сведения о буфере экрана консоли.

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

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

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

Замечания

Совет

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

Requirements

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

См. также

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

CONSOLE_SCREEN_BUFFER_INFOEX

GetConsoleScreenBufferInfoEx