Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
OnEndEdit
Collapse the table of content
Expand the table of content

ITfTextEditSink::OnEndEdit method

Syntax


HRESULT OnEndEdit(
  [in] ITfContext    *pic,
  [in] TfEditCookie  ecReadOnly,
  [in] ITfEditRecord *pEditRecord
);

Parameters

pic [in]

Pointer to the ITfContext interface for the edited context.

ecReadOnly [in]

Specifies a TfEditCookie value for read-only access to the context.

pEditRecord [in]

Pointer to the ITfEditRecord interface used to access the modifications to the context.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

An edit session with read/write access is requested with a call to the ITfContext::RequestEditSession method using the TF_ES_READWRITE flag, which establishes an ITfEditSession::DoEditSession method to perform the session. When such a ITfEditSession::DoEditSession method completes, TSF calls this method.

A text service can use the ecReadOnly parameter only to view the context. If changes are required, the text service must use an asynchronous call to the ITfContext::RequestEditSession method. However, a text service should modify only text that it previously entered as part of a composition. Otherwise, two or more text services could repeatedly modify the same text. A text service can use the ITfContext::InWriteSession method to determine if it performed the completed edit session.

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

Imekrcic.dll

See also

ITfTextEditSink
ITfContext
ITfContext::InWriteSession
ITfContext::RequestEditSession
ITfEditRecord
ITfEditSession::DoEditSession
TfEditCookie

 

 

Community Additions

ADD
Show:
© 2015 Microsoft