GetConsoleAliases function

Article
02/12/2021

Important

This document describes console platform functionality that is no longer a part of our ecosystem roadmap. We do not recommend using this content in new products, but we will continue to support existing usages for the indefinite future. Our preferred modern solution focuses on virtual terminal sequences for maximum compatibility in cross-platform scenarios. You can find more information about this design decision in our classic console vs. virtual terminal document.

Retrieves all defined console aliases for the specified executable.

Syntax

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

Parameters

lpAliasBuffer [out]
A pointer to a buffer that receives the aliases.

The format of the data is as follows: Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0, where N is the number of console aliases defined.

AliasBufferLength [in]
The size of the buffer pointed to by lpAliasBuffer, in bytes.

lpExeName [in]
The executable file whose aliases are to be retrieved.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

To determine the required size for the lpExeName buffer, use the GetConsoleAliasesLength function.

To compile an application that uses this function, define _WIN32_WINNT as 0x0501 or later. For more information, see Using the Windows Headers.

Tip

This API is not recommended and does not have a virtual terminal equivalent. This decision intentionally aligns the Windows platform with other operating systems where the individual client application acting as a shell or interpreter is expected to maintain its own user-convenience functionality like line reading and manipulation behavior including aliases and command history. Applications remoting via cross-platform utilities and transports like SSH may not work as expected if using this API.

Requirements


Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	ConsoleApi3.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll
Unicode and ANSI names	GetConsoleAliasesW (Unicode) and GetConsoleAliasesA (ANSI)