getconsolealiaseslength.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
GetConsoleAliasesLength function	Retrieves the required size for the buffer used by the GetConsoleAliases function.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi3/GetConsoleAliasesLength wincon/GetConsoleAliasesLength GetConsoleAliasesLength consoleapi3/GetConsoleAliasesLengthA wincon/GetConsoleAliasesLengthA GetConsoleAliasesLengthA consoleapi3/GetConsoleAliasesLengthW wincon/GetConsoleAliasesLengthW GetConsoleAliasesLengthW	base.getconsolealiaseslength consoles.getconsolealiaseslength	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	29e49eba-0864-4ed7-af82-1ba639261c40	apiref	GetConsoleAliasesLength GetConsoleAliasesLengthA GetConsoleAliasesLengthW	Kernel32.dll	DllExport

GetConsoleAliasesLength function

[!INCLUDE not-recommended-banner]

Retrieves the required size for the buffer used by the GetConsoleAliases function.

Syntax

DWORD WINAPI GetConsoleAliasesLength(
  _In_ LPTSTR lpExeName
);

Parameters

lpExeName [in]
The name of the executable file whose console aliases are to be retrieved.

Return value

The size of the buffer required to store all console aliases defined for this executable file, in bytes.

Remarks

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

[!INCLUDE no-vt-equiv-shell-banner]

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	GetConsoleAliasesLengthW (Unicode) and GetConsoleAliasesLengthA (ANSI)

See also

AddConsoleAlias

Console Aliases

Console Functions

GetConsoleAlias

GetConsoleAliases

GetConsoleAliasExes