Função RemovePropA (winuser.h)

Artigo
11/20/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

Tipo: 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 atom, ele deverá ter sido criado usando a função GlobalAddAtom. O atom, um valor de 16 bits, deve ser colocado na palavra de ordem baixa de lpString; a palavra de alta ordem deve ser zero.

Valor de retorno

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.

Observações

O valor retornado é o 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 do Isolamento de Privilégios de Interface do Usuário (UIPI). Um processo só pode chamar essa função em uma janela pertencente a um processo de nível de integridade menor ou igual. Quando a propriedade de blocos de UIPI for alterada, GetLastError retornará 5.

Exemplos

Para obter um exemplo, consulte Excluindo uma propriedade de janela.

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winuser.h (inclua Windows.h)
biblioteca	User32.lib
de DLL	User32.dll
conjunto de API	ext-ms-win-ntuser-window-l1-1-0 (introduzido no Windows 8)

Consulte também

AddAtom

Conceitual

getprop

de referência de

SetProp

Propriedades da janela

Compartilhar via