IProgressItems::get__NewEnum method (imapi2fs.h)

Article
02/22/2024

Retrieves the list of progress items from the collection.

Syntax

HRESULT get__NewEnum(
  [out] IEnumVARIANT **NewEnum
);

Parameters

[out] NewEnum

An IEnumVariant interface that you use to enumerate the progress items contained within the collection. Each item of the enumeration is a VARIANT whose type is VT_DISPATCH. Query the pdispVal member to retrieve the IProgressItem interface.

Return value

S_OK is returned when the number of requested elements (celt) are returned successfully or the number of returned items (pceltFetched) is less than the number of requested elements. The celt and pceltFetched parameters are defined by IEnumVariant.

Other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code	Description
E_POINTER	Pointer is not valid. Value: 0x80004003
E_OUTOFMEMORY	Failed to allocate the required memory. Value: 0x8007000E

Remarks

The enumeration is a snapshot of the progress items contained in the collection at the time of the call.

To retrieve a single item, see the IProgressItems::get_Item property.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi2fs.h