This function asks a property bag to read a named property as an integer.


SHPropertyBag_ReadInt (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    LPINT pValue);


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 pValue argument provides the address of a variable that is to receive the property value as an integer.

Return Value

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


If any of the ppb, pszPropName and pValue arguments are NULL, the function fails, with E_INVALIDARG as the error code. If the function cannot read the named property as a VT_I4 type (using SHPropertyBag_ReadType), it fails.


The SHPropertyBag_ReadInt function is exported from SHLWAPI as ordinal 529 in version 6.00. It is (presently) implemented as an alias of SHPropertyBag_ReadLONG.

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.