This topic has not yet been rated - Rate this topic

GetConsoleAlias function

Applies to: desktop apps only

Retrieves the text for the specified console alias and executable.

Syntax

Copy

DWORD WINAPI GetConsoleAlias(
  __in   LPTSTR lpSource,
  __out  LPTSTR lpTargetBuffer,
  __in   DWORD TargetBufferLength,
  __in   LPTSTR lpExeName
);

Parameters

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.

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 compile an application that uses this function, define _WIN32_WINNT as 0x0501 or later. For more information, see Using the Windows Headers.

Requirements