Función SetConsoleCursorInfo

Artículo
12/15/2023

Importante

En este documento se describe funcionalidad de la plataforma de consola que ya no forma parte de nuestra hoja de ruta del ecosistema. No se recomienda usar este contenido en nuevos productos, pero seguiremos admitiendo los usos existentes en un futuro indefinido. Nuestra solución moderna preferida se centra en secuencias de terminal virtual para lograr la máxima compatibilidad en escenarios multiplataforma. Puede encontrar más información sobre esta decisión de diseño en nuestro documento de Comparación de consola clásica y terminal virtual.

Establece el tamaño y la visibilidad del cursor para el búfer de pantalla de consola especificado.

Sintaxis

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

Parámetros

hConsoleOutput [in]
Identificador del búfer de pantalla de la consola. El identificador debe tener derecho de acceso de GENERIC_READ. Para obtener más información, consulte Seguridad y derechos de acceso del búfer de la consola.

lpConsoleCursorInfo [in]
Un puntero a una estructura CONSOLE_CURSOR_INFO que proporciona las nuevas especificaciones para el cursor del búfer de pantalla de la consola.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Cuando un cursor de búfer de pantalla está visible, su apariencia puede variar, desde llenar completamente una celda de carácter hasta aparecer como una línea horizontal en la parte inferior de la celda. El miembro dwSize de la estructura CONSOLE_CURSOR_INFO especifica el porcentaje de una celda de caracteres rellenada por el cursor. Si este miembro es menor que 1 o mayor que 100, se produce un error en SetConsoleCursorInfo.

Sugerencia

Esta API tiene un terminal virtual equivalente en la sección de visibilidad del cursor con las secuencias ^[[?25h y ^[[?25l.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	ConsoleApi2.h (a través de WinCon.h, incluido Windows.h)
Biblioteca	Kernel32.lib
Archivo DLL	Kernel32.dll