Expand Minimize

IEnumSTATPROPSETSTG interface

The IEnumSTATPROPSETSTG interface iterates through an array of STATPROPSETSTG structures. The STATPROPSETSTG structures contain statistical data about the property sets managed by the current IPropertySetStorage instance. IEnumSTATPROPSETSTG has the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone.

The implementation defines the order in which the property sets are enumerated. Property sets that are present when the enumerator is created, and are not removed during the enumeration, will be enumerated only once. Property sets added or deleted while the enumeration is in progress may or may not be enumerated, but, if enumerated, will not be enumerated more than once.

For more information about how the COM compound document implementation of IEnumSTATPROPSETSTG::Next supplies members of the STATPROPSETSTG structure, see IEnumSTATPROPSETSTG--Compound File Implementation.

When to implement

Implement IEnumSTATPROPSETSTG to enumerate the property sets supported by the current property set storage object. If using the compound file implementation of the storage object, a pointer to which is available through a call to StgCreateDocfile, IEnumSTATPROPSETSTG is implemented on that object, and a pointer is returned through a call to IPropertySetStorage::Enum. If performing a custom implementation of IPropertySetStorage, implement IEnumSTATPROPSETSTG to fill a caller-allocated array of STATPROPSETSTG structures, each of which contain data about nested elements in the storage object.

When to use

Call IPropertySetStorage::Enum to return a pointer to IEnumSTATPROPSETSTG, the methods of which can then be called to enumerate STATPROPSETSTG structures so the application can manage its property sets.

Members

The IEnumSTATPROPSETSTG interface inherits from the IUnknown interface. IEnumSTATPROPSETSTG also has these types of members:

Methods

The IEnumSTATPROPSETSTG interface has these methods.

MethodDescription
Clone

Creates an enumerator that contains the same enumeration state as the current STATPROPSETSTG structure enumerator.

Next

Gets a specified number of STATPROPSETSTG structures.

Reset

Resets the enumeration sequence to the beginning of the STATPROPSETSTG structure array.

Skip

Skips a specified number of STATPROPSETSTG structures in the enumeration sequence.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Header

Propidl.h

IDL

Propidl.idl

Library

Uuid.lib

DLL

Ole32.dll

IID

IID_IEnumSTATPROPSETSTG is defined as 0000013B-0000-0000-C000-000000000046

See also

IPropertyStorage::Enum

 

 

Community Additions

ADD
Show:
© 2014 Microsoft