| title | description | author | ms.author | ms.topic | keywords | f1_keywords | MS-HAID | MSHAttr | ms.assetid | topic_type | api_name | api_location | api_type | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GetConsoleAlias function |
Retrieves the text for the specified console alias and the name of the executable. |
miniksa |
miniksa |
article |
console, character mode applications, command line applications, terminal applications, console api |
|
|
|
e8514f24-8121-4fad-94bb-c9eedf7a700d |
|
|
|
|
[!INCLUDE not-recommended-banner]
Retrieves the text for the specified console alias and executable.
DWORD WINAPI GetConsoleAlias(
_In_ LPTSTR lpSource,
_Out_ LPTSTR lpTargetBuffer,
_In_ DWORD TargetBufferLength,
_In_ LPTSTR lpExeName
);lpSource [in]
The console alias whose text is to be retrieved.
lpTargetBuffer [out]
A pointer to a buffer that receives the text associated with the console alias.
TargetBufferLength [in]
The size of the buffer pointed to by lpTargetBuffer, in bytes.
lpExeName [in]
The name of the executable file.
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.
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]
| 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 | GetConsoleAliasW (Unicode) and GetConsoleAliasA (ANSI) |