IDiaEnumSegments

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Enumerates the various segments contained in the data source.

Syntax

IDiaEnumSegments : IUnknown

Methods in Vtable Order

The following table shows the methods of IDiaEnumSegments.

Method Description
IDiaEnumSegments::get__NewEnum Retrieves the IEnumVARIANT Interface version of this enumerator.
IDiaEnumSegments::get_Count Retrieves the number of segments.
IDiaEnumSegments::Item Retrieves a segment by means of an index.
IDiaEnumSegments::Next Retrieves a specified number of segments in the enumeration sequence.
IDiaEnumSegments::Skip Skips a specified number of segments in an enumeration sequence.
IDiaEnumSegments::Reset Resets an enumeration sequence to the beginning.
IDiaEnumSegments::Clone Creates an enumerator that contains the same enumeration state as the current enumerator.

Remarks

Notes for Callers

Obtain this interface by calling the QueryInterface method on an IDiaTable object. See the example for details.

Example

This example shows how to obtain the IDiaEnumSections interface from a table. For a more complete example of using segments, see the IDiaSegment interface.

void ShowSegments(IDiaTable *pTable, IDiaSession *pSession)
{
    CComPtr<IDiaEnumSegments> pSegments;
    if ( SUCCEEDED( pTable->QueryInterface(
                                __uuidof( IDiaEnumSegments ),
                                (void**)&pSegments )
                  )
       )
    {
        // Do something with this enumeration
    }
}

Requirements

Header: Dia2.h

Library: diaguids.lib

DLL: msdia80.dll

See also