Función AddConsoleAlias

Artículo
12/21/2023

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.

Define un alias de consola para el ejecutable especificado.

Sintaxis

BOOL WINAPI AddConsoleAlias(
  _In_ LPCTSTR Source,
  _In_ LPCTSTR Target,
  _In_ LPCTSTR ExeName
);

Parámetros

Origen [in]
Alias de consola que se va a asignar al texto especificado en Objetivo.

Objetivo [in]
Texto que se va a sustituir por Source. Si este parámetro es NULL, se quita el alias de la consola.

ExeName [in]
Nombre del archivo ejecutable para el que se va a definir el alias de consola.

Valor devuelto

Si la función se ejecuta correctamente, se devolverá el valor TRUE.

Si la función produce un error, el valor devuelto es FALSE. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Para compilar una aplicación que use esta función, defina _WIN32_WINNT como 0x0501 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 en los que se espera que la aplicación cliente individual que actúe como shell o intérprete mantenga su propia funcionalidad para la comodidad del usuario, como la lectura de líneas y el comportamiento de manipulación, incluidos los alias y el historial de comandos. 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.

Ejemplos

Para ver un ejemplo, consulte Alias de consola.

Requisitos


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