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.

ITextStoreAnchor::GetFormattedText method

The ITextStoreAnchor::GetFormattedText method returns formatted text information from a text stream.

Syntax

C++


HRESULT GetFormattedText(
  [in]  IAnchor     *paStart,
  [in]  IAnchor     *paEnd,
  [out] IDataObject **ppDataObject
);

Parameters

paStart [in]: Anchor position at which to start retrieval of formatted text.
paEnd [in]: Anchor position at which to end retrieval of formatted text.
ppDataObject [out]: Pointer to the IDataObject object that contains the formatted text.

Return value

This method can return one of these values.

Value	Description
S_OK	The method was successful.
E_FAIL	The method was unable to obtain a valid interface pointer to the start and/or end anchors.
E_NOTIMPL	An application can return this value if the method is not implemented.
TS_E_NOLOCK	The caller does not have a read/write lock on the document.

Remarks

Text, embedded objects, and any formatting are wrapped into a single IDataObject object. In this way private appliation-specific formatting associated with text can be preserved by a client.

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps \| Windows Store apps]
Minimum supported server	Windows 2000 Server [desktop apps \| Windows Store apps]
Redistributable	TSF 1.0 on Windows 2000 Professional
Header	Textstor.h
IDL	Textstor.idl
DLL	Msctf.dll