Función WriteConsoleOutputCharacter

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.

Copia una serie de caracteres en celdas consecutivas de un búfer de pantalla de consola, comenzando en una ubicación especificada.

Sintaxis

BOOL WINAPI WriteConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  LPCTSTR lpCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfCharsWritten
);

Parámetros

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

lpCharacter [in]
Los caracteres que se escribirán en el búfer de pantalla de la consola.

nLength [in]
El número de caracteres que se va a escribir.

dwWriteCoord [in]
Una estructura COORD que especifica las coordenadas de caracteres de la primera celda del búfer de pantalla de la consola en la que se escribirán los caracteres.

lpNumberOfCharsWritten [out]
Puntero a una variable que recibe el número de caracteres escritos realmente.

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

Si el número de caracteres que se van a escribir se extiende más allá del final de la fila especificada en el búfer de pantalla de la consola, los caracteres se escriben en la fila siguiente. Si el número de caracteres que se van a escribir se extiende más allá del final del búfer de pantalla de la consola, los caracteres se escriben hasta el final del búfer de pantalla de la consola.

Los valores de atributo de las posiciones en las que se escriben no se cambian.

Esta función usa caracteres Unicode o caracteres de 8 bits de la página de códigos actual de la consola. La página de códigos de la consola tiene como valor predeterminado la página de códigos OEM del sistema. Para cambiar la página de códigos de la consola, use las funciones SetConsoleCP o SetConsoleOutputCP. Los consumidores heredados también pueden usar los comandos chcp o mode con cp select=, pero no se recomienda si va a desarrollar algo nuevo.

Sugerencia

Esta API tiene un terminal virtual equivalente en las secuencias de formato de texto y posicionamiento del cursor. Mueva el cursor a la ubicación para insertar, aplique el formato deseado y escriba texto para rellenarlo. No hay ningún equivalente a emitir texto a un área sin aplicar también el formato de color activo. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos en los que se espera que la aplicación cliente individual recuerde su propio estado dibujado para su posterior manipulación.

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
Nombres Unicode y ANSI	WriteConsoleOutputCharacterW (Unicode) y WriteConsoleOutputCharacterA (ANSI)