Inheritance diagram for CViewStatePropertyBag:

[legend]

Collaboration diagram for CViewStatePropertyBag:

[legend]

Public Member Functions
	CViewStatePropertyBag ()

	~CViewStatePropertyBag () override

HRESULT	Init (_In_opt_ LPCITEMIDLIST pidl, _In_opt_ LPCWSTR pszPath, _In_ DWORD dwVspbFlags)

BOOL	IsSameBag (LPCITEMIDLIST pidl, LPCWSTR pszPath, DWORD dwVspbFlags) const

STDMETHODIMP	Read (_In_z_ LPCWSTR pszPropName, _Inout_ VARIANT pvari, _Inout_opt_ IErrorLog pErrorLog) override

STDMETHODIMP	Write (_In_z_ LPCWSTR pszPropName, _In_ VARIANT *pvari) override

Public Member Functions inherited from CBasePropertyBag
	CBasePropertyBag (DWORD dwMode)

virtual	~CBasePropertyBag ()

STDMETHODIMP	QueryInterface (REFIID riid, void **ppvObject) override

	STDMETHODIMP_ (ULONG) AddRef() override

	STDMETHODIMP_ (ULONG) Release() override

Public Member Functions inherited from IPropertyBag
HRESULT	Read ([in] LPCOLESTR pszPropName, [in, out] VARIANT pVar, [in] IErrorLog pErrorLog)

HRESULT	RemoteRead ([in] LPCOLESTR pszPropName, [out] VARIANT pVar, [in] IErrorLog pErrorLog, [in] DWORD varType, [in] IUnknown *pUnkObj)

HRESULT	Write ([in] LPCOLESTR pszPropName, [in] VARIANT *pVar)

Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)

ULONG	AddRef ()

ULONG	Release ()

Protected Member Functions
BOOL	_IsSamePidl (LPCITEMIDLIST pidlOther) const

BOOL	_IsSystemFolder () const

BOOL	_CanAccessPidlBag () const

BOOL	_CanAccessUserDefaultsBag () const

BOOL	_CanAccessFolderDefaultsBag () const

BOOL	_CanAccessGlobalDefaultsBag () const

BOOL	_CanAccessInheritBag () const

BOOL	_CanAccessUpgradeBag () const

HKEY	_GetHKey (DWORD dwVspbFlags)

UINT	_GetMRUSize (HKEY hKey)

HRESULT	_GetMRUSlots (LPCITEMIDLIST pidl, DWORD dwMode, HKEY hKey, UINT puSlots, UINT cSlots, UINT pcSlots)

HRESULT	_GetMRUSlot (LPCITEMIDLIST pidl, DWORD dwMode, HKEY hKey, UINT *pSlot)

HRESULT	_GetRegKey (LPCITEMIDLIST pidl, LPCWSTR pszBagName, DWORD dwFlags, DWORD dwMode, HKEY hKey, LPWSTR pszDest, INT cchDest)

HRESULT	_CreateBag (LPITEMIDLIST pidl, LPCWSTR pszPath, DWORD dwVspbFlags, DWORD dwMode, REFIID riid, IPropertyBag **pppb)

HRESULT	_FindNearestInheritBag (REFIID riid, IPropertyBag **pppb)

void	_ResetTryAgainFlag ()

BOOL	_EnsureReadBag (DWORD dwMode, REFIID riid)

BOOL	_EnsurePidlBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureInheritBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureUpgradeBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureUserDefaultsBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureFolderDefaultsBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureGlobalDefaultsBag (DWORD dwMode, REFIID riid)

BOOL	_EnsureWriteBag (DWORD dwMode, REFIID riid)

HRESULT	_ReadPidlBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

HRESULT	_ReadInheritBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

HRESULT	_ReadUpgradeBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

HRESULT	_ReadUserDefaultsBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

HRESULT	_ReadFolderDefaultsBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

HRESULT	_ReadGlobalDefaultsBag (LPCWSTR pszPropName, VARIANT pvari, IErrorLog pErrorLog)

void	_PruneMRUTree ()

Protected Attributes
LPITEMIDLIST	m_pidl = NULL

LPWSTR	m_pszPath = NULL

DWORD	m_dwVspbFlags = 0

CComPtr< IPropertyBag >	m_pPidlBag

CComPtr< IPropertyBag >	m_pUpgradeBag

CComPtr< IPropertyBag >	m_pInheritBag

CComPtr< IPropertyBag >	m_pUserDefaultsBag

CComPtr< IPropertyBag >	m_pFolderDefaultsBag

CComPtr< IPropertyBag >	m_pGlobalDefaultsBag

CComPtr< IPropertyBag >	m_pReadBag

CComPtr< IPropertyBag >	m_pWriteBag

BOOL	m_bPidlBag = FALSE

BOOL	m_bUpgradeBag = FALSE

BOOL	m_bInheritBag = FALSE

BOOL	m_bUserDefaultsBag = FALSE

BOOL	m_bFolderDefaultsBag = FALSE

BOOL	m_bGlobalDefaultsBag = FALSE

BOOL	m_bReadBag = FALSE

BOOL	m_bWriteBag = FALSE

Protected Attributes inherited from CBasePropertyBag
LONG	m_cRefs

DWORD	m_dwMode

Additional Inherited Members
Public Types inherited from IPropertyBag
typedef IPropertyBag *	LPPROPERTYBAG

Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 1204 of file propbag.cpp.

Constructor & Destructor Documentation

◆ CViewStatePropertyBag()

CViewStatePropertyBag::CViewStatePropertyBag ( )

inline

Definition at line 1288 of file propbag.cpp.

1288: CBasePropertyBag(STGM_READ) { }

CBasePropertyBag

Definition: propbag.cpp:32

STGM_READ

#define STGM_READ

Definition: objbase.h:917

◆ ~CViewStatePropertyBag()

CViewStatePropertyBag::~CViewStatePropertyBag ( )

inlineoverride

Definition at line 1290 of file propbag.cpp.

    {
        ::ILFree(m_pidl);
        ::LocalFree(m_pszPath);
    }

Member Function Documentation

◆ _CanAccessFolderDefaultsBag()

BOOL CViewStatePropertyBag::_CanAccessFolderDefaultsBag ( ) const

protected

Definition at line 1382 of file propbag.cpp.

{
    if (_CanAccessUserDefaultsBag())
        return TRUE;
 
    return ((m_dwVspbFlags & SHGVSPB_ALLUSERS) && (m_dwVspbFlags & SHGVSPB_PERFOLDER));
}

Referenced by _CanAccessGlobalDefaultsBag(), and _EnsureFolderDefaultsBag().

◆ _CanAccessGlobalDefaultsBag()

BOOL CViewStatePropertyBag::_CanAccessGlobalDefaultsBag ( ) const

protected

Definition at line 1390 of file propbag.cpp.

{
    if (_CanAccessFolderDefaultsBag())
        return TRUE;
 
    return ((m_dwVspbFlags & SHGVSPB_GLOBALDEAFAULTS) == SHGVSPB_GLOBALDEAFAULTS);
}

Referenced by _EnsureGlobalDefaultsBag().

◆ _CanAccessInheritBag()

BOOL CViewStatePropertyBag::_CanAccessInheritBag ( ) const

protected

Definition at line 1398 of file propbag.cpp.

{
    return (_CanAccessPidlBag() || (m_dwVspbFlags & SHGVSPB_INHERIT));
}

Referenced by _EnsureInheritBag().

◆ _CanAccessPidlBag()

BOOL CViewStatePropertyBag::_CanAccessPidlBag ( ) const

protected

Definition at line 1369 of file propbag.cpp.

{
    return ((m_dwVspbFlags & SHGVSPB_FOLDER) == SHGVSPB_FOLDER);
}

Referenced by _CanAccessInheritBag(), _CanAccessUserDefaultsBag(), and _EnsurePidlBag().

◆ _CanAccessUpgradeBag()

BOOL CViewStatePropertyBag::_CanAccessUpgradeBag ( ) const

protected

Definition at line 1403 of file propbag.cpp.

{
    return StrCmpW(m_pszPath, L"Desktop") == 0;
}

Referenced by _EnsureUpgradeBag().

◆ _CanAccessUserDefaultsBag()

BOOL CViewStatePropertyBag::_CanAccessUserDefaultsBag ( ) const

protected

Definition at line 1374 of file propbag.cpp.

{
    if (_CanAccessPidlBag())
        return TRUE;
 
    return ((m_dwVspbFlags & SHGVSPB_USERDEFAULTS) == SHGVSPB_USERDEFAULTS);
}

Referenced by _CanAccessFolderDefaultsBag(), and _EnsureUserDefaultsBag().

◆ _CreateBag()

HRESULT CViewStatePropertyBag::_CreateBag	(	LPITEMIDLIST	pidl,
		LPCWSTR	pszPath,
		DWORD	dwVspbFlags,
		DWORD	dwMode,
		REFIID	riid,
		IPropertyBag **	pppb
	)

protected

Definition at line 1534 of file propbag.cpp.

{
    HRESULT hr;
    HKEY hKey;
    CComPtr<IBindCtx> pBC;
    CComPtr<IShellFolder> psf;
    WCHAR szBuff[64];
 
    if (MODE_CAN_WRITE(dwMode))
        dwMode |= STGM_CREATE;
 
    if ((dwVspbFlags & SHGVSPB_ALLUSERS) && (dwVspbFlags & SHGVSPB_PERFOLDER))
    {
        hr = BindCtx_CreateWithMode(dwMode, &pBC);
        if (SUCCEEDED(hr))
        {
            hr = SHGetDesktopFolder(&psf);
            if (SUCCEEDED(hr))
            {
                hr = psf->BindToObject(m_pidl, pBC, riid, (void **)pppb);
                if (SUCCEEDED(hr) && !*pppb)
                    hr = E_FAIL;
            }
        }
    }
    else
    {
        hKey = _GetHKey(dwVspbFlags);
        if (!hKey)
            return E_FAIL;
 
        hr = _GetRegKey(pidl, pszPath, dwVspbFlags, dwMode, hKey, szBuff, _countof(szBuff));
        if (SUCCEEDED(hr))
            hr = SHCreatePropertyBagOnRegKey(hKey, szBuff, dwMode, riid, (void**)pppb);
 
        ::RegCloseKey(hKey);
    }
 
    return hr;
}

Referenced by _EnsureFolderDefaultsBag(), _EnsureGlobalDefaultsBag(), _EnsurePidlBag(), _EnsureReadBag(), _EnsureUserDefaultsBag(), and _EnsureWriteBag().

◆ _EnsureFolderDefaultsBag()

BOOL CViewStatePropertyBag::_EnsureFolderDefaultsBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1662 of file propbag.cpp.

{
    if (!m_pFolderDefaultsBag && !m_bFolderDefaultsBag && _CanAccessFolderDefaultsBag())
    {
        m_bFolderDefaultsBag = TRUE;
        if (_IsSystemFolder())
        {
            _CreateBag(m_pidl, m_pszPath, SHGVSPB_PERFOLDER | SHGVSPB_ALLUSERS,
                       dwMode, riid, &m_pFolderDefaultsBag);
        }
    }
    return (m_pFolderDefaultsBag != NULL);
}

Referenced by _ReadFolderDefaultsBag().

◆ _EnsureGlobalDefaultsBag()

BOOL CViewStatePropertyBag::_EnsureGlobalDefaultsBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1676 of file propbag.cpp.

{
    if (!m_pGlobalDefaultsBag && !m_bGlobalDefaultsBag && _CanAccessGlobalDefaultsBag())
    {
        m_bGlobalDefaultsBag = TRUE;
        _CreateBag(NULL, m_pszPath, SHGVSPB_GLOBALDEAFAULTS, dwMode, riid, &m_pGlobalDefaultsBag);
    }
    return (m_pGlobalDefaultsBag != NULL);
}

Referenced by _ReadGlobalDefaultsBag().

◆ _EnsureInheritBag()

BOOL CViewStatePropertyBag::_EnsureInheritBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1632 of file propbag.cpp.

{
    if (!m_pInheritBag && !m_bInheritBag && _CanAccessInheritBag())
    {
        m_bInheritBag = TRUE;
        _FindNearestInheritBag(riid, &m_pInheritBag);
    }
    return (m_pInheritBag != NULL);
}

Referenced by _ReadInheritBag().

◆ _EnsurePidlBag()

BOOL CViewStatePropertyBag::_EnsurePidlBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1622 of file propbag.cpp.

{
    if (!m_pPidlBag && !m_bPidlBag && _CanAccessPidlBag())
    {
        m_bPidlBag = TRUE;
        _CreateBag(m_pidl, m_pszPath, SHGVSPB_FOLDER, dwMode, riid, &m_pPidlBag);
    }
    return (m_pPidlBag != NULL);
}

Referenced by _ReadPidlBag().

◆ _EnsureReadBag()

BOOL CViewStatePropertyBag::_EnsureReadBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1612 of file propbag.cpp.

{
    if (!m_pReadBag && !m_bReadBag)
    {
        m_bReadBag = TRUE;
        _CreateBag(m_pidl, m_pszPath, m_dwVspbFlags, dwMode, riid, &m_pReadBag);
    }
    return (m_pReadBag != NULL);
}

Referenced by Read().

◆ _EnsureUpgradeBag()

BOOL CViewStatePropertyBag::_EnsureUpgradeBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1642 of file propbag.cpp.

{
    if (!m_pUpgradeBag && !m_bUpgradeBag && _CanAccessUpgradeBag())
    {
        m_bUpgradeBag = TRUE;
        SHGetDesktopUpgradePropertyBag(riid, (void**)&m_pUpgradeBag);
    }
    return (m_pUpgradeBag != NULL);
}

Referenced by _ReadUpgradeBag().

◆ _EnsureUserDefaultsBag()

BOOL CViewStatePropertyBag::_EnsureUserDefaultsBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1652 of file propbag.cpp.

{
    if (!m_pUserDefaultsBag && !m_bUserDefaultsBag && _CanAccessUserDefaultsBag())
    {
        m_bUserDefaultsBag = TRUE;
        _CreateBag(NULL, m_pszPath, SHGVSPB_USERDEFAULTS, dwMode, riid, &m_pUserDefaultsBag);
    }
    return (m_pUserDefaultsBag != NULL);
}

Referenced by _ReadUserDefaultsBag().

◆ _EnsureWriteBag()

BOOL CViewStatePropertyBag::_EnsureWriteBag	(	DWORD	dwMode,
		REFIID	riid
	)

protected

Definition at line 1814 of file propbag.cpp.

{
    if (!m_pWriteBag && !m_bWriteBag)
    {
        m_bWriteBag = TRUE;
        _CreateBag(m_pidl, m_pszPath, m_dwVspbFlags, dwMode, riid, &m_pWriteBag);
        if (m_pWriteBag)
        {
            _ResetTryAgainFlag();
            if (m_dwVspbFlags & SHGVSPB_INHERIT)
                _PruneMRUTree();
        }
    }
    return (m_pWriteBag != NULL);
}

Referenced by Write().

◆ _FindNearestInheritBag()

HRESULT CViewStatePropertyBag::_FindNearestInheritBag	(	REFIID	riid,
		IPropertyBag **	pppb
	)

protected

Definition at line 1582 of file propbag.cpp.

{
    *pppb = NULL;
 
    HKEY hKey = _GetHKey(SHGVSPB_INHERIT);
    if (!hKey)
        return E_FAIL;
 
    UINT cSlots, anSlots[64];
    if (FAILED(_GetMRUSlots(m_pidl, 0, hKey, anSlots, _countof(anSlots), &cSlots)) || !cSlots)
    {
        ::RegCloseKey(hKey);
        return E_FAIL;
    }
 
    HRESULT hr = E_FAIL;
    WCHAR szBuff[64];
    for (UINT iSlot = 0; iSlot < cSlots; ++iSlot)
    {
        StringCchPrintfW(szBuff, _countof(szBuff), L"Bags\\%d\\%s\\Inherit", anSlots[iSlot],
                         m_pszPath);
        hr = SHCreatePropertyBagOnRegKey(hKey, szBuff, STGM_READ, riid, (void**)pppb);
        if (SUCCEEDED(hr))
            break;
    }
 
    ::RegCloseKey(hKey);
    return hr;
}

Referenced by _EnsureInheritBag().

◆ _GetHKey()

HKEY CViewStatePropertyBag::_GetHKey ( DWORD dwVspbFlags )

protected

Definition at line 1424 of file propbag.cpp.

{
    if (!(dwVspbFlags & (SHGVSPB_INHERIT | SHGVSPB_PERUSER)))
        return SHGetShellKey((SHKEY_Key_Shell | SHKEY_Root_HKLM), NULL, TRUE);
 
    if ((m_dwVspbFlags & SHGVSPB_ROAM) && (dwVspbFlags & SHGVSPB_PERFOLDER))
        return SHGetShellKey((SHKEY_Key_Shell | SHKEY_Root_HKCU), NULL, TRUE);
 
    return SHGetShellKey(SHKEY_Key_ShellNoRoam | SHKEY_Root_HKCU, NULL, TRUE);
}

Referenced by _CreateBag(), _FindNearestInheritBag(), and _PruneMRUTree().

◆ _GetMRUSize()

UINT CViewStatePropertyBag::_GetMRUSize ( HKEY hKey )

protected

Definition at line 1435 of file propbag.cpp.

{
    DWORD dwValue, cbValue = sizeof(dwValue);
 
    if (SHGetValueW(hKey, NULL, L"BagMRU Size", NULL, &dwValue, &cbValue) != ERROR_SUCCESS)
        return 400; // The default size of the MRU (most recently used) list
 
    return (UINT)dwValue;
}

Referenced by _GetMRUSlots().

◆ _GetMRUSlot()

HRESULT CViewStatePropertyBag::_GetMRUSlot	(	LPCITEMIDLIST	pidl,
		DWORD	dwMode,
		HKEY	hKey,
		UINT *	pSlot
	)

protected

Definition at line 1475 of file propbag.cpp.

{
    UINT cSlots;
    return _GetMRUSlots(pidl, dwMode, hKey, pSlot, 1, &cSlots);
}

Referenced by _GetRegKey().

◆ _GetMRUSlots()

HRESULT CViewStatePropertyBag::_GetMRUSlots	(	LPCITEMIDLIST	pidl,
		DWORD	dwMode,
		HKEY	hKey,
		UINT *	puSlots,
		UINT	cSlots,
		UINT *	pcSlots
	)

protected

Definition at line 1446 of file propbag.cpp.

{
    CComPtr<IMruPidlList> pMruList;
    HRESULT hr = ::CoCreateInstance(CLSID_MruPidlList, NULL, CLSCTX_INPROC_SERVER,
                                    IID_IMruPidlList, (void**)&pMruList);
    if (FAILED(hr))
        return hr;
 
    UINT cMRUSize = _GetMRUSize(hKey);
    hr = pMruList->InitList(cMRUSize, hKey, L"BagMRU");
    if (FAILED(hr))
        return hr;
 
    hr = pMruList->QueryPidl(pidl, cSlots, puSlots, pcSlots);
    if (hr == S_OK && MODE_CAN_WRITE(dwMode))
        hr = pMruList->UsePidl(pidl, puSlots);
    else if (cSlots == 1)
        hr = E_FAIL;
 
    return hr;
}

Referenced by _FindNearestInheritBag(), and _GetMRUSlot().

◆ _GetRegKey()

HRESULT CViewStatePropertyBag::_GetRegKey	(	LPCITEMIDLIST	pidl,
		LPCWSTR	pszBagName,
		DWORD	dwFlags,
		DWORD	dwMode,
		HKEY	hKey,
		LPWSTR	pszDest,
		INT	cchDest
	)

protected

Definition at line 1482 of file propbag.cpp.

{
    HRESULT hr = S_OK;
    UINT nSlot;
 
    if (dwFlags & (SHGVSPB_INHERIT | SHGVSPB_PERFOLDER))
    {
        hr = _GetMRUSlot(pidl, dwMode, hKey, &nSlot);
        if (SUCCEEDED(hr))
        {
            if (dwFlags & SHGVSPB_INHERIT)
                StringCchPrintfW(pszDest, cchDest, L"Bags\\%d\\%s\\Inherit", nSlot, pszBagName);
            else
                StringCchPrintfW(pszDest, cchDest, L"Bags\\%d\\%s", nSlot, pszBagName);
        }
    }
    else
    {
        StringCchPrintfW(pszDest, cchDest, L"Bags\\AllFolders\\%s", pszBagName);
    }
 
    return hr;
}

Referenced by _CreateBag().

◆ _IsSamePidl()

BOOL CViewStatePropertyBag::_IsSamePidl ( LPCITEMIDLIST pidlOther ) const

protected

Definition at line 1339 of file propbag.cpp.

{
    if (!pidlOther && !m_pidl)
        return TRUE;
 
    return (pidlOther && m_pidl && ILIsEqual(pidlOther, m_pidl));
}

Referenced by IsSameBag().

◆ _IsSystemFolder()

BOOL CViewStatePropertyBag::_IsSystemFolder ( ) const

protected

Definition at line 1352 of file propbag.cpp.

{
    LPCITEMIDLIST ppidlLast;
    CComPtr<IShellFolder> psf;
 
    HRESULT hr = SHBindToParent(m_pidl, IID_IShellFolder, (void **)&psf, &ppidlLast);
    if (FAILED(hr))
        return FALSE;
 
    WIN32_FIND_DATAW FindData;
    hr = SHGetDataFromIDListW(psf, ppidlLast, SHGDFIL_FINDDATA, &FindData, sizeof(FindData));
    if (FAILED(hr))
        return FALSE;
 
    return PathIsSystemFolderW(NULL, FindData.dwFileAttributes);
}

Referenced by _EnsureFolderDefaultsBag().

◆ _PruneMRUTree()

void CViewStatePropertyBag::_PruneMRUTree ( )

protected

Definition at line 1795 of file propbag.cpp.

{
    HKEY hKey = _GetHKey(SHGVSPB_INHERIT);
    if (!hKey)
        return;
 
    CComPtr<IMruPidlList> pMruList;
    HRESULT hr = ::CoCreateInstance(CLSID_MruPidlList, NULL, CLSCTX_INPROC_SERVER,
                                    IID_IMruPidlList, (void**)&pMruList);
    if (SUCCEEDED(hr))
    {
        hr = pMruList->InitList(200, hKey, L"BagMRU");
        if (SUCCEEDED(hr))
            pMruList->PruneKids(m_pidl);
    }
 
    ::RegCloseKey(hKey);
}

Referenced by _EnsureWriteBag().

◆ _ReadFolderDefaultsBag()

HRESULT CViewStatePropertyBag::_ReadFolderDefaultsBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1735 of file propbag.cpp.

{
    if (!_EnsureFolderDefaultsBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pFolderDefaultsBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ReadGlobalDefaultsBag()

HRESULT CViewStatePropertyBag::_ReadGlobalDefaultsBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1747 of file propbag.cpp.

{
    if (!_EnsureGlobalDefaultsBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pGlobalDefaultsBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ReadInheritBag()

HRESULT CViewStatePropertyBag::_ReadInheritBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1699 of file propbag.cpp.

{
    if (!_EnsureInheritBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pInheritBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ReadPidlBag()

HRESULT CViewStatePropertyBag::_ReadPidlBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1687 of file propbag.cpp.

{
    if (!_EnsurePidlBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pPidlBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ReadUpgradeBag()

HRESULT CViewStatePropertyBag::_ReadUpgradeBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1711 of file propbag.cpp.

{
    if (!_EnsureUpgradeBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pUpgradeBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ReadUserDefaultsBag()

HRESULT CViewStatePropertyBag::_ReadUserDefaultsBag	(	LPCWSTR	pszPropName,
		VARIANT *	pvari,
		IErrorLog *	pErrorLog
	)

protected

Definition at line 1723 of file propbag.cpp.

{
    if (!_EnsureUserDefaultsBag(STGM_READ, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pUserDefaultsBag->Read(pszPropName, pvari, pErrorLog);
}

Referenced by Read().

◆ _ResetTryAgainFlag()

void CViewStatePropertyBag::_ResetTryAgainFlag ( )

protected

Definition at line 1408 of file propbag.cpp.

{
    if (m_dwVspbFlags & SHGVSPB_NOAUTODEFAULTS)
        m_bReadBag = FALSE;
    else if ((m_dwVspbFlags & SHGVSPB_FOLDER) == SHGVSPB_FOLDER)
        m_bPidlBag = FALSE;
    else if (m_dwVspbFlags & SHGVSPB_INHERIT)
        m_bInheritBag = FALSE;
    else if ((m_dwVspbFlags & SHGVSPB_USERDEFAULTS) == SHGVSPB_USERDEFAULTS)
        m_bUserDefaultsBag = FALSE;
    else if ((m_dwVspbFlags & SHGVSPB_ALLUSERS) && (m_dwVspbFlags & SHGVSPB_PERFOLDER))
        m_bFolderDefaultsBag = FALSE;
    else if ((m_dwVspbFlags & SHGVSPB_GLOBALDEAFAULTS) == SHGVSPB_GLOBALDEAFAULTS)
        m_bGlobalDefaultsBag = FALSE;
}

Referenced by _EnsureWriteBag().

◆ Init()

HRESULT CViewStatePropertyBag::Init	(	_In_opt_ LPCITEMIDLIST	pidl,
		_In_opt_ LPCWSTR	pszPath,
		_In_ DWORD	dwVspbFlags
	)

Definition at line 1315 of file propbag.cpp.

{
    if (pidl)
    {
        m_pidl = ILClone(pidl);
        if (!m_pidl)
            return E_OUTOFMEMORY;
    }
 
    if (pszPath)
    {
        m_pszPath = StrDupW(pszPath);
        if (!m_pszPath)
            return E_OUTOFMEMORY;
 
        m_dwVspbFlags = dwVspbFlags;
    }
 
    return S_OK;
}

◆ IsSameBag()

BOOL CViewStatePropertyBag::IsSameBag	(	LPCITEMIDLIST	pidl,
		LPCWSTR	pszPath,
		DWORD	dwVspbFlags
	)		const

Definition at line 1347 of file propbag.cpp.

{
    return (dwVspbFlags == m_dwVspbFlags && StrCmpW(pszPath, m_pszPath) == 0 && _IsSamePidl(pidl));
}

◆ Read()

STDMETHODIMP CViewStatePropertyBag::Read	(	_In_z_ LPCWSTR	pszPropName,
		_Inout_ VARIANT *	pvari,
		_Inout_opt_ IErrorLog *	pErrorLog
	)

override

Definition at line 1759 of file propbag.cpp.

{
    if ((m_dwVspbFlags & SHGVSPB_NOAUTODEFAULTS) || (m_dwVspbFlags & SHGVSPB_INHERIT))
    {
        if (!_EnsureReadBag(STGM_READ, IID_IPropertyBag))
            return E_FAIL;
 
        return m_pReadBag->Read(pszPropName, pvari, pErrorLog);
    }
 
    HRESULT hr = _ReadPidlBag(pszPropName, pvari, pErrorLog);
    if (SUCCEEDED(hr))
        return hr;
 
    hr = _ReadInheritBag(pszPropName, pvari, pErrorLog);
    if (SUCCEEDED(hr))
        return hr;
 
    hr = _ReadUpgradeBag(pszPropName, pvari, pErrorLog);
    if (SUCCEEDED(hr))
        return hr;
 
    hr = _ReadUserDefaultsBag(pszPropName, pvari, pErrorLog);
    if (SUCCEEDED(hr))
        return hr;
 
    hr = _ReadFolderDefaultsBag(pszPropName, pvari, pErrorLog);
    if (SUCCEEDED(hr))
        return hr;
 
    return _ReadGlobalDefaultsBag(pszPropName, pvari, pErrorLog);
}

◆ Write()

STDMETHODIMP CViewStatePropertyBag::Write	(	_In_z_ LPCWSTR	pszPropName,
		_In_ VARIANT *	pvari
	)

override

Definition at line 1830 of file propbag.cpp.

{
    if (!_EnsureWriteBag(STGM_WRITE, IID_IPropertyBag))
        return E_FAIL;
 
    return m_pWriteBag->Write(pszPropName, pvari);
}

Member Data Documentation

◆ m_bFolderDefaultsBag

BOOL CViewStatePropertyBag::m_bFolderDefaultsBag = FALSE

protected

Definition at line 1222 of file propbag.cpp.

Referenced by _EnsureFolderDefaultsBag(), and _ResetTryAgainFlag().

◆ m_bGlobalDefaultsBag

BOOL CViewStatePropertyBag::m_bGlobalDefaultsBag = FALSE

protected

Definition at line 1223 of file propbag.cpp.

Referenced by _EnsureGlobalDefaultsBag(), and _ResetTryAgainFlag().

◆ m_bInheritBag

BOOL CViewStatePropertyBag::m_bInheritBag = FALSE

protected

Definition at line 1220 of file propbag.cpp.

Referenced by _EnsureInheritBag(), and _ResetTryAgainFlag().

◆ m_bPidlBag

BOOL CViewStatePropertyBag::m_bPidlBag = FALSE

protected

Definition at line 1218 of file propbag.cpp.

Referenced by _EnsurePidlBag(), and _ResetTryAgainFlag().

◆ m_bReadBag

BOOL CViewStatePropertyBag::m_bReadBag = FALSE

protected

Definition at line 1224 of file propbag.cpp.

Referenced by _EnsureReadBag(), and _ResetTryAgainFlag().

◆ m_bUpgradeBag

BOOL CViewStatePropertyBag::m_bUpgradeBag = FALSE

protected

Definition at line 1219 of file propbag.cpp.

Referenced by _EnsureUpgradeBag().

◆ m_bUserDefaultsBag

BOOL CViewStatePropertyBag::m_bUserDefaultsBag = FALSE

protected

Definition at line 1221 of file propbag.cpp.

Referenced by _EnsureUserDefaultsBag(), and _ResetTryAgainFlag().

◆ m_bWriteBag

BOOL CViewStatePropertyBag::m_bWriteBag = FALSE

protected

Definition at line 1225 of file propbag.cpp.

Referenced by _EnsureWriteBag().

◆ m_dwVspbFlags

DWORD CViewStatePropertyBag::m_dwVspbFlags = 0

protected

Definition at line 1209 of file propbag.cpp.

Referenced by _CanAccessFolderDefaultsBag(), _CanAccessGlobalDefaultsBag(), _CanAccessInheritBag(), _CanAccessPidlBag(), _CanAccessUserDefaultsBag(), _EnsureReadBag(), _EnsureWriteBag(), _GetHKey(), _ResetTryAgainFlag(), Init(), IsSameBag(), and Read().

◆ m_pFolderDefaultsBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pFolderDefaultsBag

protected

Definition at line 1214 of file propbag.cpp.

Referenced by _EnsureFolderDefaultsBag(), and _ReadFolderDefaultsBag().

◆ m_pGlobalDefaultsBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pGlobalDefaultsBag

protected

Definition at line 1215 of file propbag.cpp.

Referenced by _EnsureGlobalDefaultsBag(), and _ReadGlobalDefaultsBag().

◆ m_pidl

LPITEMIDLIST CViewStatePropertyBag::m_pidl = NULL

protected

Definition at line 1207 of file propbag.cpp.

Referenced by _CreateBag(), _EnsureFolderDefaultsBag(), _EnsurePidlBag(), _EnsureReadBag(), _EnsureWriteBag(), _FindNearestInheritBag(), _IsSamePidl(), _IsSystemFolder(), _PruneMRUTree(), Init(), and ~CViewStatePropertyBag().

◆ m_pInheritBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pInheritBag

protected

Definition at line 1212 of file propbag.cpp.

Referenced by _EnsureInheritBag(), and _ReadInheritBag().

◆ m_pPidlBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pPidlBag

protected

Definition at line 1210 of file propbag.cpp.

Referenced by _EnsurePidlBag(), and _ReadPidlBag().

◆ m_pReadBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pReadBag

protected

Definition at line 1216 of file propbag.cpp.

Referenced by _EnsureReadBag(), and Read().

◆ m_pszPath

LPWSTR CViewStatePropertyBag::m_pszPath = NULL

protected

Definition at line 1208 of file propbag.cpp.

Referenced by _CanAccessUpgradeBag(), _EnsureFolderDefaultsBag(), _EnsureGlobalDefaultsBag(), _EnsurePidlBag(), _EnsureReadBag(), _EnsureUserDefaultsBag(), _EnsureWriteBag(), _FindNearestInheritBag(), Init(), IsSameBag(), and ~CViewStatePropertyBag().

◆ m_pUpgradeBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pUpgradeBag

protected

Definition at line 1211 of file propbag.cpp.

Referenced by _EnsureUpgradeBag(), and _ReadUpgradeBag().

◆ m_pUserDefaultsBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pUserDefaultsBag

protected

Definition at line 1213 of file propbag.cpp.

Referenced by _EnsureUserDefaultsBag(), and _ReadUserDefaultsBag().

◆ m_pWriteBag

CComPtr<IPropertyBag> CViewStatePropertyBag::m_pWriteBag

protected

Definition at line 1217 of file propbag.cpp.

Referenced by _EnsureWriteBag(), and Write().

The documentation for this class was generated from the following file:

dll/win32/shlwapi/propbag.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CViewStatePropertyBag()

◆ ~CViewStatePropertyBag()

Member Function Documentation

◆ _CanAccessFolderDefaultsBag()

◆ _CanAccessGlobalDefaultsBag()

◆ _CanAccessInheritBag()

◆ _CanAccessPidlBag()

◆ _CanAccessUpgradeBag()

◆ _CanAccessUserDefaultsBag()

◆ _CreateBag()

◆ _EnsureFolderDefaultsBag()

◆ _EnsureGlobalDefaultsBag()

◆ _EnsureInheritBag()

◆ _EnsurePidlBag()

◆ _EnsureReadBag()

◆ _EnsureUpgradeBag()

◆ _EnsureUserDefaultsBag()

◆ _EnsureWriteBag()

◆ _FindNearestInheritBag()

◆ _GetHKey()

◆ _GetMRUSize()

◆ _GetMRUSlot()

◆ _GetMRUSlots()

◆ _GetRegKey()

◆ _IsSamePidl()

◆ _IsSystemFolder()

◆ _PruneMRUTree()

◆ _ReadFolderDefaultsBag()

◆ _ReadGlobalDefaultsBag()

◆ _ReadInheritBag()

◆ _ReadPidlBag()

◆ _ReadUpgradeBag()

◆ _ReadUserDefaultsBag()

◆ _ResetTryAgainFlag()

◆ Init()

◆ IsSameBag()

◆ Read()

◆ Write()

Member Data Documentation

◆ m_bFolderDefaultsBag

◆ m_bGlobalDefaultsBag

◆ m_bInheritBag

◆ m_bPidlBag

◆ m_bReadBag

◆ m_bUpgradeBag

◆ m_bUserDefaultsBag

◆ m_bWriteBag

◆ m_dwVspbFlags

◆ m_pFolderDefaultsBag

◆ m_pGlobalDefaultsBag

◆ m_pidl

◆ m_pInheritBag

◆ m_pPidlBag

◆ m_pReadBag

◆ m_pszPath

◆ m_pUpgradeBag

◆ m_pUserDefaultsBag

◆ m_pWriteBag