Функция SetConsoleCursorInfo

  • Статья

Важно!

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

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

Синтаксис

BOOL WINAPI SetConsoleCursorInfo(
  _In_       HANDLE              hConsoleOutput,
  _In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);

Параметры

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

lpConsoleCursorInfo [in]
Указатель на CONSOLE_CURSOR_INFO структуру, которая предоставляет новые спецификации для курсора буфера экрана консоли.

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

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

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

Замечания

Когда курсор буфера экрана отображается, его внешний вид может отличаться, начиная от полного заполнения ячейки символа до горизонтальной линии в нижней части ячейки. Элемент dwSize структуры CONSOLE_CURSOR_INFO указывает процент символьной ячейки, заполненной курсором. Если этот элемент меньше 1 или больше 100, SetConsoleCursorInfo завершается ошибкой.

Совет

Этот API имеет виртуальный терминал, эквивалентный разделу видимости курсора, и ^[[?25h^[[?25l последовательности.

Requirements

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

См. также

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

Буферы экрана консоли

CONSOLE_CURSOR_INFO

GetConsoleCursorInfo

SetConsoleCursorPosition