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

Статья
11/20/2024

Удаляет запись из списка свойств указанного окна. Указанная строка символов идентифицирует запись, которая будет удалена.

Синтаксис

HANDLE RemovePropA(
  [in] HWND   hWnd,
  [in] LPCSTR lpString
);

Параметры

[in] hWnd

Тип: HWND

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

[in] lpString

Тип: LPCTSTR

Строка символов, завершающаяся значением NULL, или атом, идентифицирующий строку. Если этот параметр является атомом, он должен быть создан с помощью функции GlobalAddAtom. Атом, 16-разрядное значение, должно быть помещено в слово с низким порядком lpString; Слово с высоким порядком должно быть равно нулю.

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

Тип: HANDLE

Возвращаемое значение определяет указанные данные. Если данные не удается найти в указанном списке свойств, возвращаемое значение NULL.

Замечания

Возвращаемое значение — это значение hData, переданное SetProp; это определяемое приложением значение. Обратите внимание, что эта функция уничтожает связь между данными и окном. При необходимости приложение должно освободить дескриптор данных, связанные с записями, удаленными из списка свойств. Приложение может удалить только те свойства, которые он добавил. Он не должен удалять свойства, добавленные другими приложениями или самой системой.

Функция removeProp возвращает дескриптор данных, связанный со строкой, чтобы приложение удалит данные, связанные с дескриптором.

Начиная с Windows Vista, RemoveProp распространяется на ограничения изоляции привилегий пользовательского интерфейса (UIPI). Процесс может вызывать эту функцию только в окне, относящемся к процессу меньшего или равного уровня целостности. Когда UIPI блокирует изменения свойств, GetLastError вернет 5.

Примеры

Пример см. в удалении свойства окна.

Заметка

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

Требования

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

См. также

AddAtom

концептуальные

GetProp

Справочник

SetProp

свойств окна

Поделиться через