Skip to content

Latest commit

 

History

History
98 lines (73 loc) · 2.76 KB

getconsolealiasexes.md

File metadata and controls

98 lines (73 loc) · 2.76 KB
title description author ms.author ms.topic keywords f1_keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
GetConsoleAliasExes function
Retrieves the names of all executable files with console aliases defined.
miniksa
miniksa
article
console, character mode applications, command line applications, terminal applications, console api
consoleapi3/GetConsoleAliasExes
wincon/GetConsoleAliasExes
GetConsoleAliasExes
consoleapi3/GetConsoleAliasExesA
wincon/GetConsoleAliasExesA
GetConsoleAliasExesA
consoleapi3/GetConsoleAliasExesW
wincon/GetConsoleAliasExesW
GetConsoleAliasExesW
base.getconsolealiasexes
consoles.getconsolealiasexes
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
c229de09-cfa6-4829-9c9a-8ff63500eaf4
apiref
GetConsoleAliasExes
GetConsoleAliasExesA
GetConsoleAliasExesW
Kernel32.dll
DllExport

GetConsoleAliasExes function

[!INCLUDE not-recommended-banner]

Retrieves the names of all executable files with console aliases defined.

Syntax

DWORD WINAPI GetConsoleAliasExes(
  _Out_ LPTSTR lpExeNameBuffer,
  _In_  DWORD  ExeNameBufferLength
);

Parameters

lpExeNameBuffer [out]
A pointer to a buffer that receives the names of the executable files.

ExeNameBufferLength [in]
The size of the buffer pointed to by lpExeNameBuffer, in bytes.

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 lpExeNameBuffer buffer, use the GetConsoleAliasExesLength function.

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 GetConsoleAliasExesW (Unicode) and GetConsoleAliasExesA (ANSI)

See also

AddConsoleAlias

Console Aliases

Console Functions

GetConsoleAlias

GetConsoleAliasExesLength

GetConsoleAliases