CEnumIDListBase Class Reference

#include <CEnumIDListBase.h>

Inheritance diagram for CEnumIDListBase:

Collaboration diagram for CEnumIDListBase:

Public Types
typedef HRESULT(CALLBACK *	CREATEINSTANCEFILTERFUNC) (void *CallerCookie, LPCITEMIDLIST pidl)
Public Types inherited from IEnumIDList
typedef IEnumIDList *	LPENUMIDLIST
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Public Member Functions
	CEnumIDListBase ()
virtual	~CEnumIDListBase ()
BOOL	AddToEnumList (LPITEMIDLIST pidl)
BOOL	DeleteList ()
BOOL	HasItemWithCLSID (LPITEMIDLIST pidl)
HRESULT	AppendItemsFromEnumerator (IEnumIDList *pEnum)
template<class T >
BOOL	HasItemWithCLSIDImpl (LPCITEMIDLIST pidl)
STDMETHOD()	Next (ULONG celt, LPITEMIDLIST *rgelt, ULONG *pceltFetched) override
STDMETHOD()	Skip (ULONG celt) override
STDMETHOD()	Reset () override
STDMETHOD()	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 ()

Static Public Member Functions
static HRESULT	CreateInstance (IEnumIDList &Source, CREATEINSTANCEFILTERFUNC Filter, void *CallerCookie, IEnumIDList **ppEnum)
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)

Protected Attributes
ENUMLIST *	mpFirst
ENUMLIST *	mpLast
ENUMLIST *	mpCurrent

Additional Inherited Members
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 26 of file CEnumIDListBase.h.

Member Typedef Documentation

CREATEINSTANCEFILTERFUNC

typedef HRESULT(CALLBACK * CEnumIDListBase::CREATEINSTANCEFILTERFUNC) (void *CallerCookie, LPCITEMIDLIST pidl)

Definition at line 60 of file CEnumIDListBase.h.

Constructor & Destructor Documentation

CEnumIDListBase()

CEnumIDListBase::CEnumIDListBase

(

)

Definition at line 25 of file CEnumIDListBase.cpp.

                                 :
    mpFirst(NULL),
    mpLast(NULL),
    mpCurrent(NULL)
{
}

~CEnumIDListBase()

CEnumIDListBase::~CEnumIDListBase ( )

virtual

Definition at line 32 of file CEnumIDListBase.cpp.

{
    DeleteList();
}

Member Function Documentation

AddToEnumList()

BOOL CEnumIDListBase::AddToEnumList

(

LPITEMIDLIST

pidl

)

Definition at line 40 of file CEnumIDListBase.cpp.

{
    ENUMLIST *pNew;
 
    TRACE("(%p)->(pidl=%p)\n", this, pidl);
 
    if (!pidl)
        return FALSE;
 
    pNew = static_cast<ENUMLIST *>(SHAlloc(sizeof(ENUMLIST)));
    if (pNew)
    {
      /*set the next pointer */
      pNew->pNext = NULL;
      pNew->pidl = pidl;
 
      /*is This the first item in the list? */
      if (!mpFirst)
      {
        mpFirst = pNew;
        mpCurrent = pNew;
      }
 
      if (mpLast)
      {
        /*add the new item to the end of the list */
        mpLast->pNext = pNew;
      }
 
      /*update the last item pointer */
      mpLast = pNew;
      TRACE("-- (%p)->(first=%p, last=%p)\n", this, mpFirst, mpLast);
      return TRUE;
    }
    return FALSE;
}

Referenced by CFileSysEnum::_AddFindResult(), CRegFolderEnum::AddItemsFromKey(), AppendItemsFromEnumerator(), CRecycleBinEnum::CBEnumRecycleBin(), CPrintersEnum::CreatePrintersEnumList(), CNetFolderEnum::EnumerateRec(), CRegFolderEnum::Initialize(), CDrivesFolderEnum::Initialize(), and CControlPanelEnum::RegisterCPanelApp().

AppendItemsFromEnumerator()

HRESULT CEnumIDListBase::AppendItemsFromEnumerator

(

IEnumIDList *

pEnum

)

Definition at line 99 of file CEnumIDListBase.cpp.

{
    LPITEMIDLIST pidl;
    DWORD dwFetched;
 
    if (!pEnum)
        return E_INVALIDARG;
 
    pEnum->Reset();
 
    while((S_OK == pEnum->Next(1, &pidl, &dwFetched)) && dwFetched)
    {
        if (!AddToEnumList(pidl))
        {
            ILFree(pidl);
            return E_OUTOFMEMORY;
        }
    }
 
    return S_OK;
}

Referenced by CControlPanelEnum::Initialize(), CDrivesFolderEnum::Initialize(), and CDesktopFolderEnum::Initialize().

Clone()

HRESULT WINAPI CEnumIDListBase::Clone ( IEnumIDList **  ppenum )

override

Implements IEnumIDList.

Definition at line 207 of file CEnumIDListBase.cpp.

{
    TRACE("(%p)->() to (%p)->() E_NOTIMPL\n", this, ppenum);
    return E_NOTIMPL;
}

CreateInstance()

HRESULT CEnumIDListBase::CreateInstance ( IEnumIDList &  Source, CREATEINSTANCEFILTERFUNC  Filter, void *  CallerCookie, IEnumIDList **  ppEnum  )

static

Definition at line 216 of file CEnumIDListBase.cpp.

{
    *ppEnum = NULL;
    CComPtr<CEnumIDListBase> pEnum;
    HRESULT hr = ShellObjectCreator(pEnum);
    if (FAILED(hr))
        return hr;
 
    for (;;)
    {
        CComHeapPtr<ITEMIDLIST> pidl;
        hr = Source.Next(1, &pidl, NULL);
        if (hr == S_OK)
        {
            if (Filter)
                hr = Filter(CallerCookie, pidl);
            if (FAILED(hr))
                return hr;
            if (hr != S_OK)
                continue;
            if (!pEnum->AddToEnumList(pidl))
                return E_OUTOFMEMORY;
            pidl.Detach(); // AddToEnumList took ownership
            continue;
        }
        if (FAILED(hr))
            return hr;
        *ppEnum = pEnum.Detach();
        return S_OK;
    }
}

Referenced by CFolderItems::EnumObjects().

DeleteList()

BOOL CEnumIDListBase::DeleteList

(

)

Definition at line 80 of file CEnumIDListBase.cpp.

{
    ENUMLIST                    *pDelete;
 
    TRACE("(%p)->()\n", this);
 
    while (mpFirst)
    {
        pDelete = mpFirst;
        mpFirst = pDelete->pNext;
        SHFree(pDelete->pidl);
        SHFree(pDelete);
    }
    mpFirst = NULL;
    mpLast = NULL;
    mpCurrent = NULL;
    return TRUE;
}

Referenced by ~CEnumIDListBase().

HasItemWithCLSID()

BOOL CEnumIDListBase::HasItemWithCLSID

(

LPITEMIDLIST

pidl

)

HasItemWithCLSIDImpl()

template<class T >

BOOL CEnumIDListBase::HasItemWithCLSIDImpl ( LPCITEMIDLIST  pidl )

inline

Definition at line 42 of file CEnumIDListBase.h.

    {
        const CLSID * const pClsid = static_cast<T*>(this)->GetPidlClsid((PCUITEMID_CHILD)pidl);
        for (ENUMLIST *pCur = mpFirst; pClsid && pCur; pCur = pCur->pNext)
        {
            const CLSID * const pEnumClsid = static_cast<T*>(this)->GetPidlClsid((PCUITEMID_CHILD)pCur->pidl);
            if (pEnumClsid && IsEqualCLSID(*pClsid, *pEnumClsid))
                return TRUE;
        }
        return FALSE;
    }

Next()

HRESULT WINAPI CEnumIDListBase::Next ( ULONG  celt, LPITEMIDLIST *  rgelt, ULONG *  pceltFetched  )

override

Definition at line 125 of file CEnumIDListBase.cpp.

{
    ULONG    i;
    HRESULT  hr = S_OK;
    LPITEMIDLIST  temp;
 
    TRACE("(%p)->(%d,%p, %p)\n", this, celt, rgelt, pceltFetched);
 
/* It is valid to leave pceltFetched NULL when celt is 1. Some of explorer's
 * subsystems actually use it (and so may a third party browser)
 */
    if(pceltFetched)
      *pceltFetched = 0;
 
    *rgelt=0;
 
    if(celt > 1 && !pceltFetched)
    { return E_INVALIDARG;
    }
 
    if(celt > 0 && !mpCurrent)
    { return S_FALSE;
    }
 
    for(i = 0; i < celt; i++)
    { if(!mpCurrent)
      { hr = S_FALSE;
        break;
      }
 
      temp = ILClone(mpCurrent->pidl);
      if (!temp)
      { hr = i ? S_FALSE : E_OUTOFMEMORY;
        break;
      }
      rgelt[i] = temp;
      mpCurrent = mpCurrent->pNext;
    }
    if(pceltFetched)
    {  *pceltFetched = i;
    }
 
    return hr;
}

Reset()

HRESULT WINAPI CEnumIDListBase::Reset ( )

override

Implements IEnumIDList.

Definition at line 197 of file CEnumIDListBase.cpp.

{
    TRACE("(%p)\n", this);
    mpCurrent = mpFirst;
    return S_OK;
}

Skip()

HRESULT WINAPI CEnumIDListBase::Skip ( ULONG  celt )

override

Implements IEnumIDList.

Definition at line 176 of file CEnumIDListBase.cpp.

{
    DWORD    dwIndex;
    HRESULT  hr = S_OK;
 
    TRACE("(%p)->(%u)\n", this, celt);
 
    for(dwIndex = 0; dwIndex < celt; dwIndex++)
    { if(!mpCurrent)
      { hr = S_FALSE;
        break;
      }
      mpCurrent = mpCurrent->pNext;
    }
    return hr;
}

Member Data Documentation

mpCurrent

ENUMLIST* CEnumIDListBase::mpCurrent

protected

Definition at line 33 of file CEnumIDListBase.h.

Referenced by AddToEnumList(), DeleteList(), Next(), Reset(), and Skip().

mpFirst

ENUMLIST* CEnumIDListBase::mpFirst

protected

Definition at line 31 of file CEnumIDListBase.h.

Referenced by AddToEnumList(), DeleteList(), HasItemWithCLSIDImpl(), CDesktopFolderEnum::Initialize(), and Reset().

mpLast

ENUMLIST* CEnumIDListBase::mpLast

protected

Definition at line 32 of file CEnumIDListBase.h.

Referenced by AddToEnumList(), DeleteList(), and CDesktopFolderEnum::Initialize().

---

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

• dll/win32/shell32/CEnumIDListBase.h
• dll/win32/shell32/CEnumIDListBase.cpp