Compartilhar via


Método ITfProperty::Clear (msctf.h)

Esvazia o valor da propriedade sobre o intervalo especificado.

Sintaxe

HRESULT Clear(
  [in] TfEditCookie ec,
  [in] ITfRange     *pRange
);

Parâmetros

[in] ec

Contém um cookie de edição que identifica o contexto de edição. Isso é obtido de ITfDocumentMgr::CreateContext ou ITfEditSession::D oEditSession.

[in] pRange

Ponteiro para uma interface ITfRange que contém o intervalo para o qual a propriedade está limpa. Se esse parâmetro for NULL, todos os valores dessa propriedade em todo o contexto de edição serão limpos.

Valor retornado

Esse método pode retornar um desses valores.

Valor Descrição
S_OK
O método foi bem-sucedido.
E_INVALIDARG
pRange é inválido.
TF_E_NOLOCK
O contexto de edição identificado por ec não tem um bloqueio de leitura/gravação.
TF_E_READONLY
O contexto de edição é somente leitura.
TF_E_NOTOWNEDRANGE
O gerenciador do TSF não possui o intervalo.

Comentários

Não é necessário chamar esse método quando um contexto está prestes a ser destruído. O gerenciador do TSF limpará todas as propriedades quando o contexto for removido da pilha de contexto.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows 2000 Server [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho msctf.h
DLL Msctf.dll
Redistribuível TSF 1.0 no Windows 2000 Professional

Confira também

ITfDocumentMgr::CreateContext

ITfEditSession::D oEditSession

ITfProperty

ITfRange