Функция SetConsoleCursorPosition

Статья
12/13/2023

Важно!

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

Задает позицию курсора в указанном буфере экрана консоли.

Синтаксис

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

Параметры

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

dwCursorPosition [in]
Структура COORD, указывающая новую позицию курсора в символах. Координаты — это столбец и строка ячейки буфера экрана. Координаты должны находиться в границах буфера экрана консоли.

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

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

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

Замечания

Позиция курсора определяет, где отображаются символы, написанные функцией WriteFile или WriteConsole, или отложенные функцией ReadFile или ReadConsole. Чтобы определить текущую позицию курсора, используйте функцию GetConsoleScreenBufferInfo .

Если новая позиция курсора не находится в границах окна буфера экрана консоли, источник окна изменяется, чтобы сделать курсор видимым.

Совет

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

Примеры

Пример см. в разделе "Использование высокоуровневых входных и выходных функций".

Requirements


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