ITextRange::GetStoryType method

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 typeValueStory typeValue
tomUnknownStory0tomEvenPagesHeaderStory6
tomMainTextStory1tomPrimaryHeaderStory7
tomFootnotesStory2tomEvenPagesFooterStory8
tomEndnotesStory3tomPrimaryFooterStory9
tomCommentsStory4tomFirstPageHeaderStory10
tomTextFrameStory5tomFirstPageFooterStory11

 

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextRange
Conceptual
Text Object Model

 

 

Show: