CRegPropertyBag Class Reference

Inheritance diagram for CRegPropertyBag:

Collaboration diagram for CRegPropertyBag:

Public Member Functions
	CRegPropertyBag (DWORD dwMode)
	~CRegPropertyBag () override
HRESULT	Init (HKEY hKey, LPCWSTR lpSubKey)
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	_ReadDword (LPCWSTR pszPropName, VARIANT *pvari)
HRESULT	_ReadString (LPCWSTR pszPropName, VARIANTARG *pvarg, UINT len)
HRESULT	_ReadBinary (LPCWSTR pszPropName, VARIANT *pvari, VARTYPE vt, DWORD uBytes)
HRESULT	_ReadStream (VARIANT *pvari, BYTE *pInit, UINT cbInit)
HRESULT	_CopyStreamIntoBuff (IStream *pStream, void *pv, ULONG cb)
HRESULT	_GetStreamSize (IStream *pStream, LPDWORD pcbSize)
HRESULT	_WriteStream (LPCWSTR pszPropName, IStream *pStream)

Protected Attributes
HKEY	m_hKey
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 273 of file propbag.cpp.

Constructor & Destructor Documentation

CRegPropertyBag()

CRegPropertyBag::CRegPropertyBag ( DWORD  dwMode )

inline

Definition at line 287 of file propbag.cpp.

        : CBasePropertyBag(dwMode)
        , m_hKey(NULL)
    {
    }

~CRegPropertyBag()

CRegPropertyBag::~CRegPropertyBag ( )

inlineoverride

Definition at line 293 of file propbag.cpp.

    {
        if (m_hKey)
            ::RegCloseKey(m_hKey);
    }

Member Function Documentation

_CopyStreamIntoBuff()

HRESULT CRegPropertyBag::_CopyStreamIntoBuff ( IStream *  pStream, void *  pv, ULONG  cb  )

protected

Definition at line 394 of file propbag.cpp.

{
    LARGE_INTEGER li;
    li.QuadPart = 0;
    HRESULT hr = pStream->Seek(li, 0, NULL);
    if (FAILED(hr))
        return hr;
    return pStream->Read(pv, cb, NULL);
}

Referenced by _WriteStream().

_GetStreamSize()

HRESULT CRegPropertyBag::_GetStreamSize ( IStream *  pStream, LPDWORD  pcbSize  )

protected

Definition at line 404 of file propbag.cpp.

{
    *pcbSize = 0;
 
    ULARGE_INTEGER ui;
    HRESULT hr = IStream_Size(pStream, &ui);
    if (FAILED(hr))
        return hr;
 
    if (ui.DUMMYSTRUCTNAME.HighPart)
        return E_FAIL; /* 64-bit value is not supported */
 
    *pcbSize = ui.DUMMYSTRUCTNAME.LowPart;
    return hr;
}

Referenced by _WriteStream().

_ReadBinary()

HRESULT CRegPropertyBag::_ReadBinary ( LPCWSTR  pszPropName, VARIANT *  pvari, VARTYPE  vt, DWORD  uBytes  )

protected

Definition at line 369 of file propbag.cpp.

{
    HRESULT hr = E_FAIL;
    if (vt != VT_UNKNOWN || uBytes < sizeof(GUID))
        return hr;
 
    LPBYTE pbData = (LPBYTE)::LocalAlloc(LMEM_ZEROINIT, uBytes);
    if (!pbData)
        return hr;
 
    if (!SHGetValueW(m_hKey, NULL, pszPropName, NULL, pbData, &uBytes) &&
        memcmp(&GUID_NULL, pbData, sizeof(GUID)) == 0)
    {
        hr = _ReadStream(pvari, pbData + sizeof(GUID), uBytes - sizeof(GUID));
    }
 
    ::LocalFree(pbData);
 
    return hr;
}

Referenced by Read().

_ReadDword()

HRESULT CRegPropertyBag::_ReadDword ( LPCWSTR  pszPropName, VARIANT *  pvari  )

protected

Definition at line 329 of file propbag.cpp.

{
    DWORD cbData = sizeof(DWORD);
    LONG error = SHGetValueW(m_hKey, NULL, pszPropName, NULL, &V_UI4(pvari), &cbData);
    if (error)
        return E_FAIL;
 
    V_VT(pvari) = VT_UI4;
    return S_OK;
}

Referenced by Read().

_ReadStream()

HRESULT CRegPropertyBag::_ReadStream ( VARIANT *  pvari, BYTE *  pInit, UINT  cbInit  )

protected

Definition at line 358 of file propbag.cpp.

{
    IStream *pStream = SHCreateMemStream(pInit, cbInit);
    V_UNKNOWN(pvari) = pStream;
    if (!pStream)
        return E_OUTOFMEMORY;
    V_VT(pvari) = VT_UNKNOWN;
    return S_OK;
}

Referenced by _ReadBinary().

_ReadString()

HRESULT CRegPropertyBag::_ReadString ( LPCWSTR  pszPropName, VARIANTARG *  pvarg, UINT  len  )

protected

Definition at line 340 of file propbag.cpp.

{
    BSTR bstr = ::SysAllocStringByteLen(NULL, len);
    V_BSTR(pvarg) = bstr;
    if (!bstr)
        return E_OUTOFMEMORY;
 
    V_VT(pvarg) = VT_BSTR;
    LONG error = SHGetValueW(m_hKey, NULL, pszPropName, NULL, bstr, (LPDWORD)&len);
    if (error)
    {
        ::VariantClear(pvarg);
        return E_FAIL;
    }
 
    return S_OK;
}

Referenced by Read().

_WriteStream()

HRESULT CRegPropertyBag::_WriteStream ( LPCWSTR  pszPropName, IStream *  pStream  )

protected

Definition at line 472 of file propbag.cpp.

{
    DWORD cbData;
    HRESULT hr = _GetStreamSize(pStream, &cbData);
    if (FAILED(hr) || !cbData)
        return hr;
 
    DWORD cbBinary = cbData + sizeof(GUID);
    LPBYTE pbBinary = (LPBYTE)::LocalAlloc(LMEM_ZEROINIT, cbBinary);
    if (!pbBinary)
        return E_OUTOFMEMORY;
 
    hr = _CopyStreamIntoBuff(pStream, pbBinary + sizeof(GUID), cbData);
    if (SUCCEEDED(hr))
    {
        if (SHSetValueW(m_hKey, NULL, pszPropName, REG_BINARY, pbBinary, cbBinary))
            hr = E_FAIL;
    }
 
    ::LocalFree(pbBinary);
    return hr;
}

Referenced by Write().

Init()

HRESULT CRegPropertyBag::Init	(	HKEY	hKey,
		LPCWSTR	lpSubKey
	)

Definition at line 306 of file propbag.cpp.

{
    REGSAM nAccess = 0;
    if (MODE_CAN_READ(m_dwMode))
        nAccess |= KEY_READ;
    if (MODE_CAN_WRITE(m_dwMode))
        nAccess |= KEY_WRITE;
 
    LONG error;
    if (m_dwMode & STGM_CREATE)
        error = ::RegCreateKeyExW(hKey, lpSubKey, 0, NULL, 0, nAccess, NULL, &m_hKey, NULL);
    else
        error = ::RegOpenKeyExW(hKey, lpSubKey, 0, nAccess, &m_hKey);
 
    if (error != ERROR_SUCCESS)
    {
        ERR("%p %s 0x%08X\n", hKey, debugstr_w(lpSubKey), error);
        return HRESULT_FROM_WIN32(error);
    }
 
    return S_OK;
}

Read()

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

override

Definition at line 421 of file propbag.cpp.

{
    UNREFERENCED_PARAMETER(pErrorLog);
 
    TRACE("%p: %s %p %p\n", this, debugstr_w(pszPropName), pvari, pErrorLog);
 
    if (!MODE_CAN_READ(m_dwMode))
    {
        ERR("%p: 0x%X\n", this, m_dwMode);
        ::VariantInit(pvari);
        return E_ACCESSDENIED;
    }
 
    VARTYPE vt = V_VT(pvari);
    VariantInit(pvari);
 
    HRESULT hr;
    DWORD dwType, cbValue;
    LONG error = SHGetValueW(m_hKey, NULL, pszPropName, &dwType, NULL, &cbValue);
    if (error != ERROR_SUCCESS)
        hr = E_FAIL;
    else if (dwType == REG_SZ)
        hr = _ReadString(pszPropName, pvari, cbValue);
    else if (dwType == REG_BINARY)
        hr = _ReadBinary(pszPropName, pvari, vt, cbValue);
    else if (dwType == REG_DWORD)
        hr = _ReadDword(pszPropName, pvari);
    else
        hr = E_FAIL;
 
    if (FAILED(hr))
    {
        ERR("%p: 0x%08X %ld: %s %p\n", this, hr, dwType, debugstr_w(pszPropName), pvari);
        ::VariantInit(pvari);
        return hr;
    }
 
    hr = ::VariantChangeTypeForRead(pvari, vt);
    if (FAILED(hr))
    {
        ERR("%p: 0x%08X %ld: %s %p\n", this, hr, dwType, debugstr_w(pszPropName), pvari);
        ::VariantInit(pvari);
    }
 
    return hr;
}

Write()

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

override

Definition at line 496 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;
    LONG error;
    VARIANTARG vargTemp = { 0 };
    switch (V_VT(pvari))
    {
        case VT_EMPTY:
            SHDeleteValueW(m_hKey, NULL, pszPropName);
            hr = S_OK;
            break;
 
        case VT_BOOL:
        case VT_I1:
        case VT_I2:
        case VT_I4:
        case VT_UI1:
        case VT_UI2:
        case VT_UI4:
        case VT_INT:
        case VT_UINT:
        {
            hr = ::VariantChangeType(&vargTemp, pvari, 0, VT_UI4);
            if (FAILED(hr))
                return hr;
 
            error = SHSetValueW(m_hKey, NULL, pszPropName, REG_DWORD, &V_UI4(&vargTemp), sizeof(DWORD));
            if (error)
                hr = E_FAIL;
 
            ::VariantClear(&vargTemp);
            break;
        }
 
        case VT_UNKNOWN:
        {
            CComPtr<IStream> pStream;
            hr = V_UNKNOWN(pvari)->QueryInterface(IID_IStream, (void **)&pStream);
            if (FAILED(hr))
                return hr;
 
            hr = _WriteStream(pszPropName, pStream);
            break;
        }
 
        default:
        {
            hr = ::VariantChangeType(&vargTemp, pvari, 0, VT_BSTR);
            if (FAILED(hr))
                return hr;
 
            int cch = lstrlenW(V_BSTR(&vargTemp));
            DWORD cb = (cch + 1) * sizeof(WCHAR);
            error = SHSetValueW(m_hKey, NULL, pszPropName, REG_SZ, V_BSTR(&vargTemp), cb);
            if (error)
                hr = E_FAIL;
 
            ::VariantClear(&vargTemp);
            break;
        }
    }
 
    return hr;
}

Member Data Documentation

m_hKey

HKEY CRegPropertyBag::m_hKey

protected

Definition at line 276 of file propbag.cpp.

Referenced by _ReadBinary(), _ReadDword(), _ReadString(), _WriteStream(), Init(), Read(), Write(), and ~CRegPropertyBag().

---

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

• dll/win32/shlwapi/propbag.cpp