Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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

ValueDescription
S_OK

The method was successful.

E_FAIL

The enumerator object cannot be initialized.

E_INVALIDARG

One or more parameters are invalid.

E_OUTOFMEMORY

The enumerator object cannot be created.

TF_E_DISCONNECTED

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

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfContextComposition
ITfEditSession::DoEditSession
ITfRange
IEnumITfCompositionView

 

 

Show:
© 2017 Microsoft