ITfRange::GetEmbedded method

The ITfRange::GetEmbedded method obtains content that corresponds to a TS_CHAR_EMBEDDED character in the text stream. The start anchor of the range of text is positioned just before the character of interest.

Syntax


HRESULT GetEmbedded(
  [in]   TfEditCookie ec,
  [in]   REFGUID rguidService,
  [in]   REFIID riid,
  [out]  IUnknown **ppunk
);

Parameters

ec [in]

Edit cookie obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.

rguidService [in]

Identifier that specifies how the embedded content is obtained.

ValueMeaning
GUID_TS_SERVICE_ACCESSIBLE

Output should be an Accessible object.

GUID_TS_SERVICE_ACTIVEX

Caller requires a direct pointer to the object that supports the interface specified by riid.

GUID_TS_SERVICE_DATAOBJECT

Content should be obtained as an IDataObject data transfer object, with riid being IID_IDataObject. Clients should specify this option when a copy of the content is required.

Caller-defined

Text services and context owners can define custom GUIDs.

 

riid [in]

UUID of the interface of the requested object.

ppunk [out]

Pointer to the object. It can be cast to match riid.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

One or more parameters are invalid.

E_NOTIMPL

The implementing application does not expose embedded objects in its text stream.

TF_E_NOINTERFACE

The object does not support the requested interface.

TF_E_NOLOCK

The value in the ec parameter is an invalid cookie, or the caller does not have a read-only lock.

TF_E_NOOBJECT

The start anchor of the range is not positioned before a TF_CHAR_EMBEDDED character.

TF_E_NOSERVICE

The content cannot be returned to match rguidService.

 

Remarks

While the obtained object might not support certain interfaces, it is likely that the object will support those interfaces associated with embedded documents or controls such as IOleObject, IDataObject, IViewObject, IPersistStorage, IOleCache, or IDispatch. The caller must use QueryInterface to probe for any interesting interface. If the method succeeds but riid is NULL, the application indicates the presence of an embedded object but does not expose the object itself. Text processors can still benefit from a notification about the potential word break.

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

ITfRange
Text Stores
Miscellaneous Framework Constants
ITfRange::InsertEmbedded
ITfDocumentMgr::CreateContext
ITfEditSession::DoEditSession
Accessible Objects
IDataObject

 

 

Community Additions

ADD
Show:
© 2014 Microsoft