ITextStory::GetText method (tom.h)

Article
02/22/2024

Gets the text in a story according to the specified conversion flags.

Syntax

HRESULT GetText(
  [in]  long Flags,
  [out] BSTR *pbstr
);

Parameters

[in] Flags

Type: long

The conversion flags.

A Flags value of 0 retrieves text the same as ITextRange::GetText. Other values include the following.

tomAdjustCRLF

tomAllowFinalEOP

tomFoldMathAlpha

tomIncludeNumbering

tomNoHidden

tomNoMathZoneBrackets

tomLanguageTag

tomTextize

tomTranslateTableCell

tomUseCRLF

[out] pbstr

Type: BSTR*

The text in the story.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code	Description
E_INVALIDARG	Invalid argument.
E_ACCESSDENIED	Write access is denied.
E_OUTOFMEMORY	Insufficient memory.

Remarks

This method is similar to using ITextRange2::GetText2 for a whole story, but it doesn’t require a range.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	tom.h

Share via