Share via

Функция GetConsoleOriginalTitle

  • Статья

Важно!

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

Извлекает исходное название текущего окна консоли.

Синтаксис

DWORD WINAPI GetConsoleOriginalTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

Параметры

lpConsoleTitle [out]
Указатель на буфер, получающий строку, завершающую значение NULL, содержащую исходное название.

nSize [in]
Размер буфера lpConsoleTitle в символах.

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

Если значение nSize равно нулю, возвращаемое значение равно нулю.

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

Если функция завершается ошибкой, возвращаемое значение равно нулю, и GetLastError возвращает код ошибки.

Замечания

Чтобы задать заголовок окна консоли, используйте функцию SetConsoleTitle . Чтобы получить текущую строку заголовка, используйте функцию GetConsoleTitle .

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

Совет

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

Requirements

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

См. также

Функции консоли

GetConsoleTitle

SetConsoleTitle