TfEditCookie

The TfEditCookie data type identifies an edit session that has a lock.

typedef DWORD TfEditCookie;

Remarks

The TfEditCookie data type is supplied by the TSF manager and is used by a client (application or text service) to identify an edit session with a read-only or read/write lock in various methods.

A TfEditCookie value is obtained in one of the following ways.

• The client calls ITfDocumentMgr::CreateContext.
• The TSF manager calls the client ITfEditSession::DoEditSession method.
• The TSF manager calls the client ITfCompositionSink::OnCompositionTerminated method.
• The TSF manager calls the client ITfCleanupContextSink::OnCleanupContext method.
• The TSF manager calls the client ITfTextEditSink::OnEndEdit method.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps | UWP apps]
Redistributable	TSF 1.0 on Windows 2000 Professional
Header	Msctf.h
IDL	Msctf.idl

See also

ITfCleanupContextSink::OnCleanupContext

ITfCompositionSink::OnCompositionTerminated

ITfDocumentMgr::CreateContext

ITfEditSession::DoEditSession

ITfTextEditSink::OnEndEdit