CIniPropertyBag Class Reference

Inheritance diagram for CIniPropertyBag:

Collaboration diagram for CIniPropertyBag:

Public Member Functions
	CIniPropertyBag (DWORD dwMode)
	~CIniPropertyBag () override
HRESULT	Init (LPCWSTR pszIniFile, LPCWSTR pszSection)
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
HRESULT	_GetSectionAndName (LPCWSTR pszStart, LPWSTR pszSection, UINT cchSectionMax, LPWSTR pszName, UINT cchNameMax)

Static Protected Member Functions
static BOOL	LooksLikeAnAlternateStream (LPCWSTR pszStart)

Protected Attributes
LPWSTR	m_pszFileName
LPWSTR	m_pszSection
BOOL	m_bAlternateStream
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 770 of file propbag.cpp.

Constructor & Destructor Documentation

CIniPropertyBag()

CIniPropertyBag::CIniPropertyBag ( DWORD  dwMode )

inline

Definition at line 794 of file propbag.cpp.

        : CBasePropertyBag(dwMode)
        , m_pszFileName(NULL)
        , m_pszSection(NULL)
        , m_bAlternateStream(FALSE)
    {
    }

~CIniPropertyBag()

CIniPropertyBag::~CIniPropertyBag ( )

inlineoverride

Definition at line 802 of file propbag.cpp.

    {
        ::LocalFree(m_pszFileName);
        ::LocalFree(m_pszSection);
    }

Member Function Documentation

_GetSectionAndName()

HRESULT CIniPropertyBag::_GetSectionAndName ( LPCWSTR  pszStart, LPWSTR  pszSection, UINT  cchSectionMax, LPWSTR  pszName, UINT  cchNameMax  )

protected

Definition at line 838 of file propbag.cpp.

{
    LPCWSTR pchSep = StrChrW(pszStart, L'\\');
    if (pchSep)
    {
        UINT cchSep = (UINT)(pchSep - pszStart + 1);
        StrCpyNW(pszSection, pszStart, __min(cchSep, cchSectionMax));
        StrCpyNW(pszName, pchSep + 1, cchNameMax);
        return S_OK;
    }
 
    if (m_pszSection)
    {
        StrCpyNW(pszSection, m_pszSection, cchSectionMax);
        StrCpyNW(pszName, pszStart, cchNameMax);
        return S_OK;
    }
 
    ERR("%p: %s\n", this, debugstr_w(pszStart));
    return E_INVALIDARG;
}

Referenced by Read(), and Write().

Init()

HRESULT CIniPropertyBag::Init	(	LPCWSTR	pszIniFile,
		LPCWSTR	pszSection
	)

Definition at line 818 of file propbag.cpp.

{
    m_pszFileName = StrDupW(pszIniFile);
    if (!m_pszFileName)
        return E_OUTOFMEMORY;
 
    // Is it an ADS (Alternate Data Stream) pathname?
    m_bAlternateStream = LooksLikeAnAlternateStream(m_pszFileName);
 
    if (pszSection)
    {
        m_pszSection = StrDupW(pszSection);
        if (!m_pszSection)
            return E_OUTOFMEMORY;
    }
 
    return S_OK;
}

LooksLikeAnAlternateStream()

static BOOL CIniPropertyBag::LooksLikeAnAlternateStream ( LPCWSTR  pszStart )

inlinestaticprotected

Definition at line 777 of file propbag.cpp.

    {
        LPCWSTR pch = StrRChrW(pszStart, NULL, L'\\');
        if (!pch)
            pch = pszStart;
        return StrChrW(pch, L':') != NULL;
    }

Referenced by Init().

Read()

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

override

Definition at line 866 of file propbag.cpp.

{
    UNREFERENCED_PARAMETER(pErrorLog);
 
    TRACE("%p: %s %p %p\n", this, debugstr_w(pszPropName), pvari, pErrorLog);
 
    VARTYPE vt = V_VT(pvari);
 
    ::VariantInit(pvari);
 
    if (!MODE_CAN_READ(m_dwMode))
    {
        ERR("%p: 0x%X\n", this, m_dwMode);
        return E_ACCESSDENIED;
    }
 
    WCHAR szSection[64], szName[64];
    HRESULT hr =
        _GetSectionAndName(pszPropName, szSection, _countof(szSection), szName, _countof(szName));
    if (FAILED(hr))
        return hr;
 
    const INT cchBuffMax = 4 * MAX_PATH; // UTF-7 needs 4 times length buffer.
    CComHeapPtr<WCHAR> pszBuff;
    if (!pszBuff.Allocate(cchBuffMax * sizeof(WCHAR)))
        return E_OUTOFMEMORY;
 
    if (!SHGetIniStringUTF7W(szSection, szName, pszBuff, cchBuffMax, m_pszFileName))
        return E_FAIL;
 
    BSTR bstr = ::SysAllocString(pszBuff);
    V_BSTR(pvari) = bstr;
    if (!bstr)
        return E_OUTOFMEMORY;
 
    V_VT(pvari) = VT_BSTR;
    return ::VariantChangeTypeForRead(pvari, vt);
}

Write()

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

override

Definition at line 909 of file propbag.cpp.

{
    TRACE("%p: %s %p\n", this, debugstr_w(pszPropName), pvari);
 
    if (!MODE_CAN_WRITE(m_dwMode))
    {
        ERR("%p: 0x%X\n", this, m_dwMode);
        return E_ACCESSDENIED;
    }
 
    HRESULT hr;
    BSTR bstr;
    VARIANTARG vargTemp = { 0 };
    switch (V_VT(pvari))
    {
        case VT_EMPTY:
            bstr = NULL;
            break;
 
        case VT_BSTR:
            bstr = V_BSTR(pvari);
            break;
 
        default:
            hr = ::VariantChangeType(&vargTemp, pvari, 0, VT_BSTR);
            if (FAILED(hr))
                goto Quit;
 
            bstr = V_BSTR(&vargTemp);
            break;
    }
 
    WCHAR szSection[64], szName[64];
    hr = _GetSectionAndName(pszPropName, szSection, _countof(szSection), szName, _countof(szName));
    if (SUCCEEDED(hr))
    {
        if (SHSetIniStringUTF7W(szSection, szName, bstr, m_pszFileName))
        {
            if (!m_bAlternateStream)
                SHChangeNotify(SHCNE_UPDATEITEM, SHCNF_PATHW, m_pszFileName, NULL);
        }
        else
        {
            hr = E_FAIL;
        }
    }
 
Quit:
    ::VariantClear(&vargTemp);
    return hr;
}

Member Data Documentation

m_bAlternateStream

BOOL CIniPropertyBag::m_bAlternateStream

protected

Definition at line 775 of file propbag.cpp.

Referenced by Init(), and Write().

m_pszFileName

LPWSTR CIniPropertyBag::m_pszFileName

protected

Definition at line 773 of file propbag.cpp.

Referenced by Init(), Read(), Write(), and ~CIniPropertyBag().

m_pszSection

LPWSTR CIniPropertyBag::m_pszSection

protected

Definition at line 774 of file propbag.cpp.

Referenced by _GetSectionAndName(), Init(), and ~CIniPropertyBag().

---

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

• dll/win32/shlwapi/propbag.cpp