ITextStoreACP::GetEmbedded method (textstor.h)
Gets an embedded document.
Syntax
HRESULT GetEmbedded(
[in] LONG acpPos,
[in] REFGUID rguidService,
[in] REFIID riid,
[out] IUnknown **ppunk
);
Parameters
[in] acpPos
Contains the character position, within the document, from where the object is obtained.
[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 |
---|---|
|
The object should be obtained as an IDataObject object. |
|
The object should be obtained as an Accessible object. |
|
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 |
---|---|
|
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
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 only] |
Minimum supported server | Windows 2000 Server [desktop apps only] |
Target Platform | Windows |
Header | textstor.h |
DLL | Msctf.dll |
Redistributable | TSF 1.0 on Windows 2000 Professional |