IEnumSTATSTG interface

The IEnumSTATSTG interface enumerates an array of STATSTG structures. These structures contain statistical data about open storage, stream, or byte array objects. IEnumSTATSTG has the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone.

When to implement

Implement IEnumSTATSTG to enumerate the elements of a storage object. If you are using the compound file implementation of the storage object, a pointer to which is available through a call to StgCreateDocfile, IEnumSTATSTG is implemented on that object, and a pointer is returned through a call to IStorage::EnumElements. If you are doing a custom implementation of a storage object, you must implement IEnumSTATSTG to fill a caller-allocated array of STATSTG structures, each of which contains data about the nested elements in the storage object.

When to use

Containers call methods that return a pointer to IEnumSTATSTG, so the container can manage its storage object and the elements within it. Calls to the IStorage::EnumElements method supply a pointer to IEnumSTATSTG. The caller allocates an array of STATSTG structures and the IEnumSTATSTG methods fill each structure with the statistics about one of the nested elements in the storage object. If present, the lpszName member of the STATSTG structure requires additional memory allocation through the IMalloc interface, and the caller must free this memory, if allocated, by calling the IMalloc::Free method. If the lpszName member is NULL, no memory is allocated, and, therefore, no memory must be freed.

Members

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

• Methods

Methods

The IEnumSTATSTG interface has these methods.

Requirements

See also

CoGetMalloc

STATSTG

IStorage::EnumElements

EnumAll Sample