Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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.

ValueMeaning
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.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

One or more parameters are invalid.

E_NOTIMPL

The application does not support embedded objects.

TF_E_INVALIDPOS

acpPos 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 embedded object at acpPos.

TS_E_NOSERVICE

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

Textstor.h

IDL

Textstor.idl

DLL

Msctf.dll

See also

ITextStoreACP2
IDataObject
Accessible Objects

 

 

Show:
© 2017 Microsoft