ITfCandidateList interface
The ITfCandidateList interface is implemented by a text service and is used by the TSF manager or a client (application or other text service) to obtain and manipulate candidate string objects.
The TSF manager implements this interface to provide access to this interface to other clients. This enables the TSF manager to function as a mediator between the client and the text service.
To obtain an instance of this interface the TSF manager or client can call ITfFnReconversion::GetReconversion.
Members
The ITfCandidateList interface inherits from the IUnknown interface. ITfCandidateList also has these types of members:
Methods
The ITfCandidateList interface has these methods.
| Method | Description |
|---|---|
| EnumCandidates |
Obtains an enumerator that contains all the candidate string objects in the candidate list. |
| GetCandidate |
Obtains a specific candidate string object. |
| GetCandidateNum |
Obtains the number of candidate string objects in the candidate list. |
| SetResult |
Specifies the result of a reconversion operation for s specific candidate string. |
Remarks
When a text service must interpret text before it is inserted into a context, there might be more than one possible interpretation of the text. Speech input is an example of this. If the spoken word is "there", other possible interpretations might be "their" or "they're". The text service will insert the most appropriate text, but there is still some chance of error involved. Text reconversion is the process of allowing the user to select alternate text for the inserted text. The alternate text objects are known as candidates.
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 |
|
|
IDL |
|
|
DLL |
|
See also