SHPropertyBag_WriteLONG

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

Declaration

HRESULT
SHPropertyBag_WriteLONG (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    LONG lValue);

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 lValue argument provides the new value as a signed 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 LONG as a VT_I4 type, the function fails.

Availability

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