ITextDocument::GetStoryRanges method (tom.h)

Article
02/22/2024

Gets the story collection object used to enumerate the stories in a document.

Syntax

HRESULT GetStoryRanges(
  ITextStoryRanges **ppStories
);

Parameters

ppStories

Type: ITextStoryRanges**

The ITextStoryRanges pointer.

Return value

Type: HRESULT

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

Return code	Description
E_NOTIMPL	Not implemented; only one story in this document.

Remarks

Invoke this method only if ITextDocument::GetStoryCount returns a value greater than 1.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll