Функция GetConsoleAliases

Статья
10/23/2023

Важно!

В этом документе описаны функции платформы консоли, которые больше не являются частью стратегии развития экосистемы. Мы не рекомендуем использовать это содержимое в новых продуктах, но мы будем продолжать поддерживать существующие использования для неопределенного будущего. Наше предпочтительное современное решение ориентировано на последовательности виртуальных терминалов для обеспечения максимальной совместимости в кроссплатформенных сценариях. Дополнительные сведения об этом решении по проектированию можно найти в классической консоли и в документе виртуального терминала .

Извлекает все определенные псевдонимы консоли для указанного исполняемого файла.

Синтаксис

DWORD WINAPI GetConsoleAliases(
  _Out_ LPTSTR lpAliasBuffer,
  _In_  DWORD  AliasBufferLength,
  _In_  LPTSTR lpExeName
);

Параметры

lpAliasBuffer [out]
Указатель на буфер, который получает псевдонимы.

Формат данных выглядит следующим образом: Source1 Target1=\0Source2 Target2=\0... SourceN TargetN=\0, где N — это число определенных псевдонимов консоли.

AliasBufferLength [in]
Размер буфера, на который указывает lpAliasBuffer, в байтах.

lpExeName [in]
Исполняемый файл, псевдоним которого требуется извлечь.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Замечания

Чтобы определить требуемый размер буфера lpExeName, используйте функцию GetConsoleAliasesLength.

Чтобы скомпилировать приложение, использующее эту функцию, определите _WIN32_WINNT как 0x0501 или более поздней версии. Дополнительные сведения см. в разделе "Использование заголовков Windows".

Совет

Этот API не рекомендуется и не имеет эквивалента виртуального терминала . Это решение намеренно выравнивает платформу Windows с другими операционными системами, где отдельное клиентское приложение, выступающее в качестве оболочки или интерпретатора, должно поддерживать собственные функции удобства пользователя, такие как поведение чтения строк и манипуляций, включая псевдонимы и журнал команд. Удаленное взаимодействие приложений с помощью межплатформенных служебных программ и транспорта, таких как SSH, может не работать должным образом, если используется этот API.

Requirements


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Верхний колонтитул	ConsoleApi3.h (через WinCon.h, включая Windows.h)
Библиотека	Kernel32.lib
DLL-библиотеки	Kernel32.dll
Имена Юникода и ANSI	GetConsoleAliasesW (Юникод) и GetConsoleAliasesA (ANSI)