Función GetConsoleAliases

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.

Recupera todos los alias de consola definidos para el ejecutable especificado.

Sintaxis

DWORD WINAPI GetConsoleAliases(
  _Out_ LPTSTR lpAliasBuffer,
  _In_  DWORD  AliasBufferLength,
  _In_  LPTSTR lpExeName
);

Parámetros

lpAliasBuffer [out]
Puntero a un búfer que recibe los alias.

El formato de los datos es el siguiente: Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0, donde N es el número de alias de consola definido.

AliasBufferLength [in]
Tamaño del búfer al que apunta lpAliasBuffer en bytes.

lpExeName [in]
Archivo ejecutable cuyos alias se van a recuperar.

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

Para determinar el tamaño requerido para el búfer lpExeName, use la función GetConsoleAliasesLength.

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.

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	GetConsoleAliasesW (Unicode) y GetConsoleAliasesA (ANSI)