ITextStoreACP2::GetEmbedded method
Gets an embedded document.
Syntax
HRESULT GetEmbedded( [in] LONG acpPos, [in] REFGUID rguidService, [in] REFIID riid, [out] IUnknown **ppunk );
Parameters
- acpPos [in]
-
Contains the character position, within the document, from where the object is obtained.
- rguidService [in]
-
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 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.
- riid [in]
-
Specifies the interface type requested.
- ppunk [out]
-
Pointer to an IUnknown pointer that receives the requested interface.
Return value
This method can return one of these values.
| Value | Description |
|---|---|
|
The method was successful. |
|
One or more parameters are invalid. |
|
The application does not support embedded objects. |
|
acpPos is not within the document. |
|
The requested interface type is unsupported. |
|
The caller does not have a read-only lock. |
|
There is no embedded object at acpPos. |
|
The service type specified in rguidService is unsupported. |
Remarks
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
|
Minimum supported client |
Windows 8 [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2012 [desktop apps | Windows Store apps] |
|
Header |
|
|
IDL |
|
|
DLL |
|
See also