This function asks a property bag to read a named property as a boolean.


SHPropertyBag_ReadBOOL (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    LPBOOL pbValue);


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

Return Value

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


If any of the ppb, pszPropName and pbValue arguments are NULL, the function fails, with E_INVALIDARG as the error code. If the function cannot read the named property as a VT_BOOL type (using SHPropertyBag_ReadType), it fails. The function interprets VARIANT_TRUE (0xFFFF) as TRUE and everything else as FALSE.


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