IPropertyStorage::DeletePropertyNames method (propidlbase.h)

Article
10/24/2022

The DeletePropertyNames method deletes specified string names from the current property set.

Syntax

HRESULT DeletePropertyNames(
  [in] ULONG           cpropid,
  [in] const PROPID [] rgpropid
);

Parameters

[in] cpropid

The size on input of the array rgpropid. If 0, no property names are deleted.

[in] rgpropid

Property identifiers for which string names are to be deleted.

Return value

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

Remarks

For each property identifier in rgpropid, IPropertyStorage::DeletePropertyNames removes any corresponding name-to-property ID mapping. An attempt is silently ignored to delete the name of a property that either does not exist or does not currently have a string name associated with it. This method has no effect on the properties themselves.

Note All the stored string property names can be deleted by deleting property identifier zero, but cpropid must be equal to 1 for this to be a valid parameter error.

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