IPropertyStorage::DeleteMultiple method (propidlbase.h)

Article
02/22/2024

The DeleteMultiple method deletes as many of the indicated properties as exist in this property set.

Syntax

HRESULT DeleteMultiple(
  [in] ULONG             cpspec,
  [in] const PROPSPEC [] rgpspec
);

Parameters

[in] cpspec

The numerical count of properties to be deleted. The value of this parameter can legally be set to zero, however that defeats the purpose of the method as no properties are thereby deleted, regardless of the value set in rgpspec.

[in] rgpspec

Properties to be deleted. A mixture of property identifiers and string-named properties is permitted. There may be duplicates, and there is no requirement that properties be specified in any order.

Return value

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

Remarks

IPropertyStorage::DeleteMultiple must delete as many of the indicated properties as are in the current property set. If a deletion of a stream- or storage-valued property occurs while that property is open, the deletion will succeed and place the previously returned IStream or IStorage pointer in the reverted state.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	propidlbase.h (include Objbase.h, Propidlbase.h)
Library	Uuid.lib
DLL	Ole32.dll

Share via