Función GetConsoleOriginalTitle
Importante
En este documento se describe la 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 para 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 la consola clásica frente al terminal virtual.
Recupera el título original de la ventana de la consola actual.
Sintaxis
DWORD WINAPI GetConsoleOriginalTitle(
_Out_ LPTSTR lpConsoleTitle,
_In_ DWORD nSize
);
Parámetros
lpConsoleTitle [in]
Puntero a un búfer que recibe una cadena terminada en null que contiene el título original.
nSize [in]
Tamaño del búfer lpConsoleTitle en caracteres.
Valor devuelto
Si nSize es cero, el valor devuelto es cero.
Si la función se ejecuta correctamente, el valor devuelto es la longitud del título de la consola original en caracteres.
Si la función no se realiza correctamente, 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 actual, utilice la función GetConsoleTitle.
Para compilar una aplicación que use esta función, defina _WIN32_WINNT como 0x0600 o posterior. Para obtener más información, consulte Uso de los encabezados de Windows.
Sugerencia
Esta API no se recomienda y no tiene un equivalente de terminal virtual. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos. Es posible que las aplicaciones que se comuniquen de forma remota a través de utilidades y transportes multiplataforma como SSH no funcionen como se espera si se utiliza esta API.
Requisitos
| Cliente mínimo compatible | Windows Vista [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows Server 2008 [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 | GetConsoleOriginalTitleW (Unicode) y GetConsoleOriginalTitleA (ANSI) |