Edit

Share via

ITextStoreACP::GetFormattedText method (textstor.h)

  • Article

The ITextStoreACP::GetFormattedText method returns formatted text data about a specified text string. The caller must have a read/write lock on the document before calling this method.

Syntax

HRESULT GetFormattedText(
  [in]  LONG        acpStart,
  [in]  LONG        acpEnd,
  [out] IDataObject **ppDataObject
);

Parameters

[in] acpStart

Specifies the starting character position of the text to get in the document.

[in] acpEnd

Specifies the ending character position of the text to get in the document. This parameter is ignored if the value is 1.

[out] ppDataObject

Receives the 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.
TS_E_NOLOCK
 The caller does not have a read/write lock on the document.

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