ITfContextComposition::FindComposition method
Syntax
HRESULT FindComposition( [in] TfEditCookie ecRead, [in] ITfRange *pTestRange, [out] IEnumITfCompositionView **ppEnum );
Parameters
- ecRead [in]
-
Contains an edit cookie that identifies the edit context. This is obtained from ITfEditSession::DoEditSession.
- pTestRange [in]
-
Pointer to an ITfRange object that specifies the range to search. This parameter can be NULL. If this parameter is NULL, the enumerator will contain all compositions in the edit context.
- ppEnum [out]
-
Pointer to an IEnumITfCompositionView interface pointer that receives the enumerator object.
Return value
| Value | Description |
|---|---|
|
The method was successful. |
|
The enumerator object cannot be initialized. |
|
One or more parameters are invalid. |
|
The enumerator object cannot be created. |
|
The context object is not on a document stack. |
The edit context identified by ecRead does not have a read-only lock.
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