SHPropertyBag_WriteSHORT

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

Declaration

HRESULT
SHPropertyBag_WriteSHORT (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    SHORT sValue);

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 sValue argument provides the new value as a signed 16-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 SHORT as a VT_UI2 type, the function fails.

Availability

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