Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfProperty::Clear method

Syntax


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

Parameters

ec [in]

Contains an edit cookie that identifies the edit context. This is obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.

pRange [in]

Pointer to an ITfRange interface that contains the range that the property is cleared for. If this parameter is NULL, all values for this property over the entire edit context are cleared.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

pRange is invalid.

TF_E_NOLOCK

The edit context identified by ec does not have a read/write lock.

TF_E_READONLY

The edit context is read-only.

TF_E_NOTOWNEDRANGE

The TSF manager does not own the range.

 

Remarks

It is not necessary to call this method when a context is about to be destroyed. The TSF manager will clear all properties when the context is removed from the context stack.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfProperty
ITfDocumentMgr::CreateContext
ITfEditSession::DoEditSession
ITfRange

 

 

Community Additions

Show:
© 2016 Microsoft