Edit

ITextRange::GetStoryType method (tom.h)

  • Article

Get the type of the range's story.

Syntax

HRESULT GetStoryType(
  long *pValue
);

Parameters

pValue

Type: long*

The type of the range's story. The pValue value can be one of the following values.

Story type Value Story type Value
tomUnknownStory 0 tomEvenPagesHeaderStory 6
tomMainTextStory 1 tomPrimaryHeaderStory 7
tomFootnotesStory 2 tomEvenPagesFooterStory 8
tomEndnotesStory 3 tomPrimaryFooterStory 9
tomCommentsStory 4 tomFirstPageHeaderStory 10
tomTextFrameStory 5 tomFirstPageFooterStory 11

Return value

Type: HRESULT

The method returns an HRESULT value. If the method succeeds, it returns S_OK. If pValue is null, the method fails and it returns E_INVALIDARG.

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

See also

Conceptual

ITextRange

Reference

Text Object Model