AddConsoleAlias function (Windows)

Applies to: desktop apps only

Defines a console alias for the specified executable.

Syntax

BOOL WINAPI AddConsoleAlias(
  __in  LPCTSTR Source,
  __in  LPCTSTR Target,
  __in  LPCTSTR ExeName
);

Parameters

Source [in]

The console alias to be mapped to the text specified by Target.

Target [in]

The text to be substituted for Source. If this parameter is NULL, then the console alias is removed.

ExeName [in]

The name of the executable file for which the console alias is to be defined.

Return value

If the function succeeds, the return value is TRUE.

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

Remarks

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

Examples

For an example, see Console Aliases.

Requirements

See also

Console Aliases

Console Functions

GetConsoleAlias

GetConsoleAliases

GetConsoleAliasExes

Send comments about this topic to Microsoft

Build date: 2/3/2012