SHPropertyBag_WriteDWORD

This function asks a property bag to write a dword as the value of a named property.

Declaration

HRESULT
SHPropertyBag_WriteDWORD (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    DWORD dwValue);

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.

The dwValue argument provides the new value as an unsigned 32-bit integer.

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 the dword as a VT_UI4 type, the function fails.

Availability

The SHPropertyBag_WriteDWORD function is exported from SHLWAPI as ordinal 508 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.