CEnumRegKey Class Reference

Inheritance diagram for CEnumRegKey:

Collaboration diagram for CEnumRegKey:

Public Member Functions
	CEnumRegKey ()
	~CEnumRegKey ()
HRESULT	Initialize (PCWSTR path, HKEY root)
HRESULT	NextKey (LPITEMIDLIST *ppidl)
HRESULT	NextValue (LPITEMIDLIST *ppidl)
HRESULT	EnumerateNext (LPITEMIDLIST *ppidl)
STDMETHODIMP	Next (ULONG celt, LPITEMIDLIST *rgelt, ULONG *pceltFetched) override
STDMETHODIMP	Skip (ULONG celt) override
STDMETHODIMP	Reset () override
STDMETHODIMP	Clone (IEnumIDList **ppenum) override
Public Member Functions inherited from ATL::CComObjectRootEx< CComMultiThreadModelNoCS >
	~CComObjectRootEx ()
ULONG	InternalAddRef ()
ULONG	InternalRelease ()
void	Lock ()
void	Unlock ()
HRESULT	_AtlInitialConstruct ()
Public Member Functions inherited from ATL::CComObjectRootBase
	CComObjectRootBase ()
	~CComObjectRootBase ()
void	SetVoid (void *)
HRESULT	_AtlFinalConstruct ()
HRESULT	FinalConstruct ()
void	InternalFinalConstructAddRef ()
void	InternalFinalConstructRelease ()
void	FinalRelease ()
Public Member Functions inherited from IEnumIDList
HRESULT	Next ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] PITEMID_CHILD *rgelt, [out] ULONG *pceltFetched)
HRESULT	Skip ([in] ULONG celt)
HRESULT	Reset ()
HRESULT	Clone ([out] IEnumIDList **ppenum)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Private Attributes
PCWSTR	m_path
HKEY	m_hkey
BOOL	m_values
int	m_idx

Additional Inherited Members
Public Types inherited from IEnumIDList
typedef IEnumIDList *	LPENUMIDLIST
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Static Public Member Functions inherited from ATL::CComObjectRootBase
static void WINAPI	ObjectMain (bool)
static const struct _ATL_CATMAP_ENTRY *	GetCategoryMap ()
static HRESULT WINAPI	InternalQueryInterface (void *pThis, const _ATL_INTMAP_ENTRY *pEntries, REFIID iid, void **ppvObject)
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 299 of file ntobjenum.cpp.

Constructor & Destructor Documentation

CEnumRegKey()

CEnumRegKey::CEnumRegKey ( )

inline

Definition at line 309 of file ntobjenum.cpp.

        : m_path(NULL), m_hkey(NULL), m_values(FALSE), m_idx(0)
    {
    }

~CEnumRegKey()

CEnumRegKey::~CEnumRegKey ( )

inline

Definition at line 314 of file ntobjenum.cpp.

    {
        RegCloseKey(m_hkey);
    }

Member Function Documentation

Clone()

STDMETHODIMP CEnumRegKey::Clone ( IEnumIDList **  ppenum )

inlineoverride

Implements IEnumIDList.

Definition at line 537 of file ntobjenum.cpp.

    {
        return E_NOTIMPL;
    }

EnumerateNext()

HRESULT CEnumRegKey::EnumerateNext ( LPITEMIDLIST *  ppidl )

inline

Definition at line 482 of file ntobjenum.cpp.

    {
        if (!m_values)
        {
            HRESULT hr = NextKey(ppidl);
            if (hr != S_FALSE)
                return hr;
 
            // switch to values.
            m_values = TRUE;
            m_idx = 0;
        }
 
        return NextValue(ppidl);
    }

Initialize()

HRESULT CEnumRegKey::Initialize ( PCWSTR  path, HKEY  root  )

inline

Definition at line 319 of file ntobjenum.cpp.

    {
        m_path = path;
 
        DWORD res;
        if (root)
        {
            res = RegOpenKeyExW(root, *path == '\\' ? path + 1 : path, 0, STANDARD_RIGHTS_READ | KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS, &m_hkey);
        }
        else
        {
            res = NtOpenObject(KEY_OBJECT, (PHANDLE) &m_hkey, STANDARD_RIGHTS_READ | KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS, path);
        }
        if (!NT_SUCCESS(res))
        {
            ERR("RegOpenKeyExW failed for path %S with status=%x\n", path, res);
            return HRESULT_FROM_NT(res);
        }
 
        return S_OK;
    }

Next()

STDMETHODIMP CEnumRegKey::Next ( ULONG  celt, LPITEMIDLIST *  rgelt, ULONG *  pceltFetched  )

inlineoverride

Definition at line 498 of file ntobjenum.cpp.

    {
        if (pceltFetched)
            *pceltFetched = 0;
 
        while (celt-- > 0)
        {
            HRESULT hr = EnumerateNext(rgelt);
            if (hr != S_OK)
                return hr;
 
            if (pceltFetched)
                (*pceltFetched)++;
            if (rgelt)
                rgelt++;
        }
 
        return S_OK;
    }

NextKey()

HRESULT CEnumRegKey::NextKey ( LPITEMIDLIST *  ppidl )

inline

Definition at line 341 of file ntobjenum.cpp.

    {
        WCHAR name[MAX_PATH];
        DWORD cchName = _countof(name);
 
        WCHAR className[MAX_PATH];
        DWORD cchClass = _countof(className);
 
        if (RegEnumKeyExW(m_hkey, m_idx++, name, &cchName, 0, className, &cchClass, NULL))
            return S_FALSE;
 
        name[cchName] = 0;
        className[cchClass] = 0;
 
        REG_ENTRY_TYPE otype = REG_ENTRY_KEY;
 
        DWORD entryBufferLength = FIELD_OFFSET(RegPidlEntry, entryName) + sizeof(WCHAR) + cchName * sizeof(WCHAR);
 
        if (cchClass > 0)
        {
            entryBufferLength += sizeof(WCHAR) + cchClass * sizeof(WCHAR);
        }
 
        // allocate space for the terminator
        entryBufferLength += FIELD_OFFSET(SHITEMID, abID);
 
        RegPidlEntry* entry = (RegPidlEntry*) CoTaskMemAlloc(entryBufferLength);
        if (!entry)
            return E_OUTOFMEMORY;
 
        memset(entry, 0, entryBufferLength);
 
        entry->cb = FIELD_OFFSET(RegPidlEntry, entryName);
        entry->magic = REGISTRY_PIDL_MAGIC;
        entry->entryType = otype;
 
        if (cchName > 0)
        {
            entry->entryNameLength = cchName * sizeof(WCHAR);
            StringCbCopyNW(entry->entryName, entryBufferLength, name, entry->entryNameLength);
            entry->cb += entry->entryNameLength + sizeof(WCHAR);
        }
        else
        {
            entry->entryNameLength = 0;
            entry->entryName[0] = 0;
            entry->cb += sizeof(WCHAR);
        }
 
        if (cchClass)
        {
            PWSTR contentData = (PWSTR) ((PBYTE) entry + entry->cb);
            DWORD remainingSpace = entryBufferLength - entry->cb;
 
            entry->contentsLength = cchClass * sizeof(WCHAR);
            StringCbCopyNW(contentData, remainingSpace, className, entry->contentsLength);
 
            entry->cb += entry->contentsLength + sizeof(WCHAR);
        }
 
        if (ppidl)
            *ppidl = (LPITEMIDLIST) entry;
        return S_OK;
    }

NextValue()

HRESULT CEnumRegKey::NextValue ( LPITEMIDLIST *  ppidl )

inline

Definition at line 406 of file ntobjenum.cpp.

    {
        WCHAR name[MAX_PATH];
        DWORD cchName = _countof(name);
        DWORD type = 0;
        DWORD dataSize = 0;
 
        if (RegEnumValueW(m_hkey, m_idx++, name, &cchName, 0, &type, NULL, &dataSize))
            return S_FALSE;
 
        REG_ENTRY_TYPE otype = REG_ENTRY_VALUE;
 
        DWORD entryBufferLength = FIELD_OFFSET(RegPidlEntry, entryName) + sizeof(WCHAR) + cchName * sizeof(WCHAR);
 
#define MAX_EMBEDDED_DATA 32
        BOOL copyData = dataSize <= MAX_EMBEDDED_DATA;
        if (copyData)
        {
            entryBufferLength += dataSize + sizeof(WCHAR);
 
            otype = REG_ENTRY_VALUE_WITH_CONTENT;
        }
 
        // allocate space for the terminator
        entryBufferLength += FIELD_OFFSET(SHITEMID, abID);
 
        RegPidlEntry* entry = (RegPidlEntry*) CoTaskMemAlloc(entryBufferLength);
        if (!entry)
            return E_OUTOFMEMORY;
 
        memset(entry, 0, entryBufferLength);
 
        entry->cb = FIELD_OFFSET(RegPidlEntry, entryName);
        entry->magic = REGISTRY_PIDL_MAGIC;
        entry->entryType = otype;
        entry->contentType = type;
 
        if (cchName > 0)
        {
            entry->entryNameLength = cchName * sizeof(WCHAR);
            StringCbCopyNW(entry->entryName, entryBufferLength, name, entry->entryNameLength);
            entry->cb += entry->entryNameLength + sizeof(WCHAR);
        }
        else
        {
            entry->entryNameLength = 0;
            entry->entryName[0] = 0;
            entry->cb += sizeof(WCHAR);
        }
 
        if (copyData)
        {
            PBYTE contentData = (PBYTE) ((PBYTE) entry + entry->cb);
 
            entry->contentsLength = dataSize;
 
            // In case it's an unterminated string, RegGetValue will add the NULL termination
            dataSize += sizeof(WCHAR);
 
            if (!RegQueryValueExW(m_hkey, name, NULL, NULL, contentData, &dataSize))
            {
                entry->cb += entry->contentsLength + sizeof(WCHAR);
            }
            else
            {
                entry->contentsLength = 0;
                entry->cb += sizeof(WCHAR);
            }
 
        }
 
        if (ppidl)
            *ppidl = (LPITEMIDLIST) entry;
        return S_OK;
    }

Reset()

STDMETHODIMP CEnumRegKey::Reset ( )

inlineoverride

Implements IEnumIDList.

Definition at line 532 of file ntobjenum.cpp.

    {
        return E_NOTIMPL;
    }

Skip()

STDMETHODIMP CEnumRegKey::Skip ( ULONG  celt )

inlineoverride

Implements IEnumIDList.

Definition at line 518 of file ntobjenum.cpp.

    {
        while (celt > 0)
        {
            HRESULT hr = EnumerateNext(NULL);
            if (FAILED(hr))
                return hr;
            if (hr != S_OK)
                break;
        }
 
        return S_OK;
    }

Member Data Documentation

m_hkey

HKEY CEnumRegKey::m_hkey

private

Definition at line 304 of file ntobjenum.cpp.

m_idx

int CEnumRegKey::m_idx

private

Definition at line 306 of file ntobjenum.cpp.

m_path

PCWSTR CEnumRegKey::m_path

private

Definition at line 303 of file ntobjenum.cpp.

m_values

BOOL CEnumRegKey::m_values

private

Definition at line 305 of file ntobjenum.cpp.

---

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

• dll/shellext/ntobjshex/ntobjenum.cpp