SHPropertyBag_Delete

This function asks a property bag to delete a named property.

Declaration

HRESULT
SHPropertyBag_Delete (
    IPropertyBag *ppb,
    LPCWSTR pszPropName);

Parameters

The ppb argument provides the address of an IPropertyBag interface.

The pszPropName argument provides the address of a null-terminated Unicode string that names the property.

Return Value

The function returns zero for success, else an error code.

Behaviour

If either of the ppb and pszPropName arguments are NULL, the function fails, with E_INVALIDARG as the error code. If the property bag’s Write method cannot write a VT_EMPTY type, the function fails.

Availability

The SHPropertyBag_Delete function is exported from SHLWAPI as ordinal 535 in version 6.00.

Though this function dates from 2001, it was still not documented by Microsoft in the MSDN Library at least as late as the CD edition dated January 2004.