Função RemovePropA (winuser.h)

Artigo
03/04/2024

Remove uma entrada da lista de propriedades da janela especificada. A cadeia de caracteres especificada identifica a entrada a ser removida.

Sintaxe

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

Parâmetros

[in] hWnd

Digite: HWND

Um identificador para a janela cuja lista de propriedades deve ser alterada.

[in] lpString

Tipo: LPCTSTR

Uma cadeia de caracteres terminada em nulo ou um átomo que identifica uma cadeia de caracteres. Se esse parâmetro for um átomo, ele deverá ter sido criado usando a função GlobalAddAtom . O átomo, um valor de 16 bits, deve ser colocado na palavra de baixa ordem de lpString; a palavra de alta ordem deve ser zero.

Retornar valor

Tipo: HANDLE

O valor retornado identifica os dados especificados. Se os dados não puderem ser encontrados na lista de propriedades especificada, o valor retornado será NULL.

Comentários

O valor retornado é o valor hData que foi passado para SetProp; é um valor definido pelo aplicativo. Observe que essa função destrói apenas a associação entre os dados e a janela. Se apropriado, o aplicativo deve liberar os identificadores de dados associados a entradas removidas de uma lista de propriedades. O aplicativo pode remover apenas as propriedades que adicionou. Ele não deve remover as propriedades adicionadas por outros aplicativos ou pelo próprio sistema.

A função RemoveProp retorna o identificador de dados associado à cadeia de caracteres para que o aplicativo possa liberar os dados associados ao identificador.

A partir do Windows Vista, RemoveProp está sujeito às restrições de UIPI (Isolamento de Privilégios de Interface do Usuário). Um processo só pode chamar essa função em uma janela que pertença a um processo de nível de integridade menor ou igual. Quando a UIPI bloqueia as alterações de propriedade, GetLastError retornará 5.

Exemplos

Para obter um exemplo, consulte Excluindo uma propriedade window.

Observação

O cabeçalho winuser.h define RemoveProp como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-window-l1-1-0 (introduzido em Windows 8)