CRegistryEnumBase Class Reference

Inheritance diagram for CRegistryEnumBase:

Collaboration diagram for CRegistryEnumBase:

Public Member Functions
virtual	~CRegistryEnumBase ()
HRESULT	Init (HKEY hKey, CRegistrySource *pSource)
STDMETHODIMP	QueryInterface (REFIID riid, void **ppvObject) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	Next (ULONG celt, LPWSTR *rgelt, ULONG *pceltFetched) override
STDMETHODIMP	Skip (ULONG celt) override
STDMETHODIMP	Reset () override
STDMETHODIMP	Clone (IEnumString **ppenum) override
Public Member Functions inherited from IEnumString
HRESULT	Next ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] LPOLESTR *rgelt, [out] ULONG *pceltFetched)
HRESULT	RemoteNext ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] LPOLESTR *rgelt, [out] ULONG *pceltFetched)
HRESULT	Skip ([in] ULONG celt)
HRESULT	Reset ()
HRESULT	Clone ([out] IEnumString **ppenum)
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	_Next (PWSTR *ppwsz)
virtual BOOL	_RegNext (DWORD dwIndex)=0
virtual DWORD	_MaxLen ()=0

Protected Attributes
LONG	m_cRefs = 1
DWORD	m_dwIndex = 0
CRegistrySource *	m_pSource = NULL
HKEY	m_hKey = NULL
PWSTR	m_pszName = NULL
WCHAR	m_szBuf [64] = {}
DWORD	m_cchNameMax = 0

Additional Inherited Members
Public Types inherited from IEnumString
typedef IEnumString *	LPENUMSTRING
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 37 of file querysrc.cpp.

Constructor & Destructor Documentation

~CRegistryEnumBase()

CRegistryEnumBase::~CRegistryEnumBase ( )

virtual

Definition at line 125 of file querysrc.cpp.

{
    if (m_pszName && m_pszName != m_szBuf)
        LocalFree(m_pszName);
    if (m_pSource)
        m_pSource->Release();
}

Member Function Documentation

_MaxLen()

virtual DWORD CRegistryEnumBase::_MaxLen ( )

protectedpure virtual

Implemented in CRegistryEnumValues, and CRegistryEnumKeys.

Referenced by Init().

_Next()

BOOL CRegistryEnumBase::_Next ( PWSTR *  ppwsz )

protected

Definition at line 151 of file querysrc.cpp.

{
    return _RegNext(m_dwIndex) && SUCCEEDED(SHStrDupW(m_pszName, ppwsz));
}

Referenced by Next().

_RegNext()

virtual BOOL CRegistryEnumBase::_RegNext ( DWORD  dwIndex )

protectedpure virtual

Implemented in CRegistryEnumValues, and CRegistryEnumKeys.

Referenced by _Next().

Clone()

STDMETHODIMP CRegistryEnumBase::Clone ( IEnumString **  ppenum )

override

Implements IEnumString.

Definition at line 215 of file querysrc.cpp.

{
    return E_NOTIMPL;
}

Init()

HRESULT CRegistryEnumBase::Init	(	HKEY	hKey,
		CRegistrySource *	pSource
	)

Definition at line 133 of file querysrc.cpp.

{
    m_hKey = hKey;
    m_pSource = pSource;
    m_pSource->AddRef();
    m_cchNameMax = _MaxLen();
    if (m_cchNameMax > _countof(m_szBuf))
    {
        m_pszName = (PWSTR)LocalAlloc(LPTR, m_cchNameMax * sizeof(WCHAR));
    }
    else
    {
        m_cchNameMax = _countof(m_szBuf);
        m_pszName = m_szBuf;
    }
    return m_pszName ? S_OK : E_OUTOFMEMORY;
}

Referenced by CRegistrySource::EnumSources(), and CRegistrySource::EnumValues().

Next()

STDMETHODIMP CRegistryEnumBase::Next ( ULONG  celt, LPWSTR *  rgelt, ULONG *  pceltFetched  )

override

Definition at line 183 of file querysrc.cpp.

{
    if (!rgelt || (celt > 1 && !pceltFetched))
        return E_INVALIDARG;
 
    ULONG cFetched = 0;
 
    while (cFetched < celt)
    {
        if (!_Next(&rgelt[cFetched]))
            break;
        ++m_dwIndex;
        ++cFetched;
    }
 
    if (pceltFetched)
        *pceltFetched = cFetched;
 
    return (cFetched == celt) ? S_OK : S_FALSE;
}

QueryInterface()

HRESULT CRegistryEnumBase::QueryInterface ( REFIID  riid, void **  ppvObject  )

override

Implements IUnknown.

Definition at line 156 of file querysrc.cpp.

{
    if (!ppv)
        return E_POINTER;
 
    if (riid == IID_IEnumString)
    {
        *ppv = static_cast<IEnumString*>(this);
        AddRef();
        return S_OK;
    }
    return E_NOINTERFACE;
}

Reset()

STDMETHODIMP CRegistryEnumBase::Reset ( )

override

Implements IEnumString.

Definition at line 209 of file querysrc.cpp.

{
    m_dwIndex = 0;
    return S_OK;
}

Skip()

STDMETHODIMP CRegistryEnumBase::Skip ( ULONG  celt )

override

Implements IEnumString.

Definition at line 204 of file querysrc.cpp.

{
    return E_NOTIMPL;
}

STDMETHODIMP_() [1/2]

CRegistryEnumBase::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

CRegistryEnumBase::STDMETHODIMP_ ( ULONG  )

override

Member Data Documentation

m_cchNameMax

DWORD CRegistryEnumBase::m_cchNameMax = 0

protected

Definition at line 46 of file querysrc.cpp.

Referenced by CRegistryEnumValues::_RegNext(), CRegistryEnumKeys::_RegNext(), and Init().

m_cRefs

LONG CRegistryEnumBase::m_cRefs = 1

protected

Definition at line 40 of file querysrc.cpp.

Referenced by STDMETHODIMP_().

m_dwIndex

DWORD CRegistryEnumBase::m_dwIndex = 0

protected

Definition at line 41 of file querysrc.cpp.

Referenced by _Next(), Next(), and Reset().

m_hKey

HKEY CRegistryEnumBase::m_hKey = NULL

protected

Definition at line 43 of file querysrc.cpp.

Referenced by CRegistryEnumValues::_MaxLen(), CRegistryEnumKeys::_MaxLen(), CRegistryEnumValues::_RegNext(), CRegistryEnumKeys::_RegNext(), and Init().

m_pSource

CRegistrySource* CRegistryEnumBase::m_pSource = NULL

protected

Definition at line 42 of file querysrc.cpp.

Referenced by Init(), and ~CRegistryEnumBase().

m_pszName

PWSTR CRegistryEnumBase::m_pszName = NULL

protected

Definition at line 44 of file querysrc.cpp.

Referenced by _Next(), CRegistryEnumValues::_RegNext(), CRegistryEnumKeys::_RegNext(), Init(), and ~CRegistryEnumBase().

m_szBuf

WCHAR CRegistryEnumBase::m_szBuf[64] = {}

protected

Definition at line 45 of file querysrc.cpp.

Referenced by Init(), and ~CRegistryEnumBase().

---

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

• dll/win32/shlwapi/querysrc.cpp