Функция GetConsoleTitle

Статья
12/13/2023

Важно!

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

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

Синтаксис

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

Параметры

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

nSize [in]
Размер буфера, на который указывает параметр lpConsoleTitle , в символах.

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

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

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

Замечания

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

Эта функция использует либо символы Юникода, либо 8-разрядные символы из текущей кодовой страницы консоли. Кодовая страница консоли по умолчанию изначально соответствует кодовой странице OEM системы. Чтобы изменить кодовую страницу консоли, используйте функции SetConsoleCP или SetConsoleOutputCP. Пользователи прежних версий могут также использовать команды chcp или mode con cp select= (но это не рекомендуется для новой разработки).

Совет

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

Примеры

Пример см. в разделе SetConsoleTitle.

Requirements


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