Función SetConsoleCursorPosition
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 la posición del cursor en el búfer de pantalla de la consola especificado.
Sintaxis
BOOL WINAPI SetConsoleCursorPosition(
_In_ HANDLE hConsoleOutput,
_In_ COORD dwCursorPosition
);
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.
dwCursorPosition [in]
Una estructura COORD que especifica la nueva posición del cursor, en caracteres. Las coordenadas son la columna y la fila de una celda de caracteres de búfer de pantalla. Las coordenadas deben estar dentro de los límites 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
La posición del cursor determina dónde se muestran los caracteres escritos por la función WriteFile o WriteConsole, o el eco de la función ReadFile o ReadConsole. Para determinar la posición actual del cursor, use la función GetConsoleScreenBufferInfo.
Si la nueva posición del cursor no está dentro de los límites de la ventana del búfer de pantalla de la consola, el origen de la ventana cambia para que el cursor sea visible.
Sugerencia
Esta API tiene un terminal virtual equivalente en las secciones de posicionamiento de cursor simple y posicionamiento de cursor. El uso de la nueva línea, retorno de carro, retroceso y secuencias de control de pestaña también puede ayudar con el posicionamiento del cursor.
Ejemplos
Para ver un ejemplo, consulte Uso de las funciones de entrada y salida de alto nivel.
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 |