SHPropertyBag_ReadDWORD

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

Declaration

HRESULT
SHPropertyBag_ReadDWORD (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    LPDWORD pdwValue);

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

Return Value

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

Behaviour

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

Availability

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