ITextStoryRanges::_NewEnum method (tom.h)

Article
02/22/2024

Retrieves an IEnumVARIANT enumerator interface for this collection of stories.

Syntax

HRESULT _NewEnum(
  IUnknown **ppunkEnum
);

Parameters

ppunkEnum

Type: IUnknown**

The pointer to the enumerator interface.

Return value

Type: HRESULT

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

Return code	Description
E_INVALIDARG	ppunkEnum is null.
E_FAIL	Failure for some other reason.

Remarks

This definition together with the implementation of IEnumVARIANT, enables one to support the following Microsoft Visual Basic for Applications (VBA) code.

    Dim t As ITextDocument
    Dim c As ITextStoryRanges
    Dim r As ITextRange

    Set t = gObj
    Set c = t.StoryRanges

    For Each r In c
        Debug.Print r.Text
    Next

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