This topic has not yet been rated - Rate this topic

GetConsoleAliases function

Applies to: desktop apps only

Retrieves all defined console aliases for the specified executable.

Syntax

Copy

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.

Requirements