Edit

Predefined Compartments

  • Article

The following values identify compartments implemented by Text Services Framework.

The following compartment identifiers are defined in Ctffunc.idl and Ctffunc.h.

Flag Value Description
GUID_COMPARTMENT_SAPI_AUDIO VT_I4 A DWORD that is zero if the Speech API (SAPI) audio is off or nonzero if the SAPI audio is on. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_SPEECH_CFGMENU VT_I4 A DWORD that is zero if the speech configuration menu is unavailable or nonzero if the speech configuration menu is available. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_SPEECH_DICTATIONSTAT VT_I4 A DWORD value that contains zero or a combination of one or more of the TF_DICTATION_ENABLED, TF_COMMANDING_ENABLED, TF_DICTATION_ON or TF_COMMANDING_ON values. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_SPEECH_UI_STATUS VT_I4 A DWORD value that contains zero or a combination of one or more of the TF_SHOW_BALLOON or TF_DISABLE_BALLOON values. This is a global compartment.

The following compartment identifiers are defined in MSCTF.IDL and MSCTF.H.

Flag Value Description
GUID_COMPARTMENT_EMPTYCONTEXT VT_I4 A DWORD that is nonzero if the context is empty or zero otherwise. This compartment is specific to a context object.
GUID_COMPARTMENT_HANDWRITING_OPENCLOSE VT_I4 A DWORD that is nonzero if the handwriting recognition is open or zero if the handwriting recognition is closed. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_KEYBOARD_DISABLED VT_I4 A DWORD that is nonzero if the keyboard is disabled or zero otherwise. This compartment is specific to a context object.
GUID_COMPARTMENT_KEYBOARD_INPUTMODE_CONVERSION VT_I4 A DWORD value of the proper combination of TF_CONVERSIONMODE_ flags. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_KEYBOARD_INPUTMODE_SENTENCE VT_I4 A DWORD value of TF_SENTENCEMODE_. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_KEYBOARD_OPENCLOSE VT_I4 A DWORD that is nonzero if the keyboard is open or zero if the keyboard is closed. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_PERSISTMENUENABLED VT_I4 A DWORD that is nonzero to cause the speech text service to enable the Save Speech Data menu item or zero to disable it. This compartment is specific to a document manager object.
GUID_COMPARTMENT_SPEECH_DISABLED VT_I4 A DWORD that contains zero or a combination of one or more of the TF_DISABLE_SPEECH, TF_DISABLE_DICTATION or TF_DISABLE_COMMANDING values. This compartment is specific to a thread manager object.
GUID_COMPARTMENT_SPEECH_OPENCLOSE VT_I4 A DWORD that is nonzero if speech input is active or zero if speech input is inactive. This is a global compartment.
GUID_COMPARTMENT_TIPUISTATUS VT_I4 Not currently used.
GUID_COMPARTMENT_TRANSITORYEXTENSION VT_I4 A DWORD value of TF_TRANSITORYEXTENSION_NONE, TF_TRANSITORYEXTENSION_FLOATING or TF_TRANSITORYEXTENSION_ATSELECTION. This compartment is specific to a document manager object.
GUID_COMPARTMENT_TRANSITORYEXTENSION_DOCUMENTMANAGER VT_I4 An IUnknown value for the ITfDocumentMgr interface that refers the transitory document of this document manager. This compartment is specific to a document manager object.
GUID_COMPARTMENT_TRANSITORYEXTENSION_PARENT VT_I4 An IUnknown value for the ITfDocumentMgr interface that refers the parent document manager of this transitory document. This compartment is specific to a document manager object.

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
Ctffunc.h;
Mstctf.h
IDL
Ctffunc.idl;
Mstctf.idl

See also

Speech Recognition Constants