ITextStoreAnchor::GetEmbedded method (textstor.h)

Article
10/13/2021

The ITextStoreAnchor::GetEmbedded method obtains an embedded object from a text stream.

Syntax

HRESULT GetEmbedded(
  [in]  DWORD    dwFlags,
  [in]  IAnchor  *paPos,
  [in]  REFGUID  rguidService,
  [in]  REFIID   riid,
  [out] IUnknown **ppunk
);

Parameters

[in] dwFlags

Bit fields that specify how the method deals with hidden text. If set to TS_GEA_HIDDEN, an embedded object can be located within hidden text. Otherwise hidden text is skipped over.

[in] paPos

Pointer to an anchor positioned immediately in front of the embedded object, as denoted by a TS_CHAR_EMBEDDED character.

[in] rguidService

Contains a GUID value that defines the requested format of the obtained object. This can be one of the following values.

Value	Meaning
GUID_TS_SERVICE_DATAOBJECT	The object should be obtained as an IDataObject data object.
GUID_TS_SERVICE_ACCESSIBLE	The object should be obtained as an Accessible object.
GUID_TS_SERVICE_ACTIVEX	The object should be obtained as an ActiveX object.

[in] riid

Specifies the interface type requested.

[out] ppunk

Pointer to an IUnknown pointer that receives the requested interface.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_FAIL	The method failed to obtain the requested object.
E_INVALIDARG	One or more parameters are invalid.
E_NOTIMPL	The implementing application does not expose embedded objects in its text stream.
TF_E_INVALIDPOS	The requested paPos anchor is not within the document.
TS_E_NOINTERFACE	The requested interface type is unsupported.
TS_E_NOLOCK	The caller does not have a read-only lock.
TS_E_NOOBJECT	There is no paPos anchor immediately in front of a TS_CHAR_EMBEDDED character.
TS_E_NOSERVICE	The service type specified in rguidService is unsupported.

Remarks

The caller must use QueryInterface to probe for appropriate interfaces. Prospective interfaces include those associated with embedded documents or controls such as IOleObject, IDataObject, IViewObject, IPersistStorage, IOleCache, or IDispatch.

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	textstor.h
DLL	Msctf.dll
Redistributable	TSF 1.0 on Windows 2000 Professional