ITfRange::GetEmbedded method (msctf.h)
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
[in] ec
Edit cookie obtained from ITfDocumentMgr::CreateContext or ITfEditSession::DoEditSession.
[in] rguidService
Identifier that specifies how the embedded content is obtained.
| Value | Meaning |
|---|---|
|
Output should be an Accessible object. |
|
Caller requires a direct pointer to the object that supports the interface specified by riid. |
|
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. |
|
Text services and context owners can define custom GUIDs. |
[in] riid
UUID of the interface of the requested object.
[out] ppunk
Pointer to the object. It can be cast to match riid.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful. |
|
One or more parameters are invalid. |
|
The implementing application does not expose embedded objects in its text stream. |
|
The object does not support the requested interface. |
|
The value in the ec parameter is an invalid cookie, or the caller does not have a read-only lock. |
|
The start anchor of the range is not positioned before a TF_CHAR_EMBEDDED character. |
|
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps | UWP apps] |
| Minimum supported server | Windows 2000 Server [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | msctf.h |
| DLL | Msctf.dll |
| Redistributable | TSF 1.0 on Windows 2000 Professional |