Функция SetWindowTextA (winuser.h)

Статья
11/20/2024

Изменяет текст строки заголовка указанного окна (если он имеется). Если указанное окно является элементом управления, текст элемента управления изменяется. Однако SetWindowText не может изменить текст элемента управления в другом приложении.

Синтаксис

BOOL SetWindowTextA(
  [in]           HWND   hWnd,
  [in, optional] LPCSTR lpString
);

Параметры

[in] hWnd

Тип: HWND

Дескриптор окна или элемента управления, текст которого необходимо изменить.

[in, optional] lpString

Тип: LPCTSTR

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

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

Тип: BOOL

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

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

Замечания

Если целевое окно принадлежит текущему процессу, SetWindowText вызывает отправку сообщения WM_SETTEXT в указанное окно или элемент управления. Если элемент управления является элементом управления списком, созданным с помощью стиля WS_CAPTION, SetWindowText задает текст элемента управления, а не для записей списка.

Чтобы задать текст элемента управления в другом процессе, отправьте сообщение WM_SETTEXT непосредственно вместо вызова SetWindowText.

Функция SetWindowText не расширяет символы вкладок (код ASCII 0x09). Символы табуляции отображаются как вертикальные (|) символы.

Примеры

Пример см. в разделе отправки сообщения.

Заметка

Заголовок winuser.h определяет SetWindowText как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll
набор API	ext-ms-win-ntuser-window-l1-1-3 (представлено в Windows 10 версии 10.0.10240)