Miscellaneous Framework Constants

Miscellaneous framework constants indicate settings for clients, processes, or text.

Constant/value Description
TF_CLIENTID_NULL
((TfClientId)0)
Indicates to a text service that the client is deactivated. See TfClientId.
TF_INVALID_GUIDATOM
((TfGuidAtom)0)
The TfGuidAtom value for the current process is invalid.
TF_DEFAULT_SELECTION
( TS_DEFAULT_SELECTION )
Use the default selection. Used by ITfContext::GetSelection, ITextStoreACP::GetSelection, and ITextStoreAnchor::GetSelection.
TF_GTP_INCL_TEXT
( 0x1 )
Specifies that the ITfEditRecord::GetTextAndPropertyUpdates method will obtain the collection of range objects that cover the text changed during the edit session.
TF_HF_OBJECT
( 1 )
The range shift stops if an embedded object is encountered. Used in dwFlags member of TF_HALTCOND structure.
TF_IE_CORRECTION
( 1 )
The text is a transform (correction) of existing content, so that other text services can preserve data associated with the original text. Used in dwFlags parameter of ITfRange::InsertEmbedded.
TF_INVALID_COOKIE
( 0xffffffff )
Not used.
TF_INVALID_EDIT_COOKIE
( 0 )
Not used.
TF_POPF_ALL
( 0x1 )
All contexts are removed from the stack. Used in dwFlags parameter of ITfDocumentMgr::Pop.
TF_ST_CORRECTION
( 1 )
The text is a transform (correction) of existing content, so that other text services can preserve data associated with the original text. Used in dwFlags parameter of ITfRange::SetText.
TF_TU_CORRECTION
( 0x1 )
The text change is the result of a transform (correction) of existing content. This implies that the semantics of the text have not changed. Used in dwFlags parameter of ITfPropertyStore::OnTextUpdated.
TF_US_HIDETIPUI
0x00000001
Not used.

Requirements

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

See also

ITextStoreACP::GetSelection

ITextStoreAnchor::GetSelection

ITfContext::GetSelection

ITfDocumentMgr::Pop

ITfEditRecord::GetTextAndPropertyUpdates

ITfPropertyStore::OnTextUpdated

ITfRange::InsertEmbedded

ITfRange::SetText

TfClientId

TfGuidAtom

TF_HALTCOND