Función GetConsoleTitle

Artículo
12/21/2023

Importante

En este documento se describe funcionalidad de la plataforma de consola que ya no forma parte de nuestro plan de desarrollo 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.

Recupera el título de la ventana de consola actual.

Sintaxis

DWORD WINAPI GetConsoleTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

Parámetros

lpConsoleTitle [out]
Puntero a un búfer que recibe una cadena terminada en null que contiene el título. Cuando el búfer es demasiado pequeño para almacenar el título, la función almacena el máximo número posible de caracteres del título en el búfer y finaliza con un terminador NULL.

nSize [in]
Tamaño del búfer al que apunta el parámetro lpConsoleTitle, en caracteres.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es la longitud del título de la ventana de consola en caracteres.

En caso contrario, el valor devuelto es cero y GetLastError devuelve el código de error.

Comentarios

Para establecer el título de una ventana de consola, utilice la función SetConsoleTitle. Para recuperar la cadena de título original, utilice la función GetConsoleOriginalTitle.

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 no se recomienda y no tiene un terminal virtual equivalente. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos. Es posible que las aplicaciones que se comunican remotamente a través de utilidades multiplataforma y los transportes como SSH no funcionen según lo previsto si se utiliza esta API.

Ejemplos

Para ver un ejemplo, consulte SetConsoleTitle.

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	GetConsoleTitleW (Unicode) y GetConsoleTitleA (ANSI)