IPropertyStorage::Enum method

The Enum method creates an enumerator object designed to enumerate data of type STATPROPSTG, which contains information on the current property set. On return, this method supplies a pointer to the IEnumSTATPROPSTG pointer on this object.

Syntax

HRESULT Enum(
  [out] IEnumSTATPROPSTG **ppenum
);

Parameters

ppenum [out]

Pointer to IEnumSTATPROPSTG pointer variable that receives the interface pointer to the new enumerator object.

Return value

This method supports the standard return value E_UNEXPECTED, in addition to the following:

S_OK

A pointer to the enumerator has been retrieved.

STG_E_ACCESSDENIED

The requested access to the property storage object has been denied.

STG_E_INSUFFICIENTMEMORY

There is not enough memory to perform this operation.

STG_E_INVALIDPARAMETER

The parameter is invalid.

STG_E_READFAULT

Error reading storage.

Remarks

IPropertyStorage::Enum creates an enumeration object that can be used to iterate STATPROPSTG structures. On return, this method supplies a pointer to an instance of the IEnumSTATPROPSTG interface on this object, whose methods you can call to obtain information about the current property set.

Requirements

See also

IEnumSTATPROPSTG

IEnumSTATPROPSTG - Compound File Implementation

EnumAll Sample

Samples