CEnumIDList Class Reference

#include <cabview.h>

Inheritance diagram for CEnumIDList:

Collaboration diagram for CEnumIDList:

Public Member Functions
	CEnumIDList ()
virtual	~CEnumIDList ()
int	FindNamedItem (PCUITEMID_CHILD pidl) const
HRESULT	Fill (LPCWSTR path, HWND hwnd=NULL, SHCONTF contf=0)
HRESULT	Fill (PCIDLIST_ABSOLUTE pidl, HWND hwnd=NULL, SHCONTF contf=0)
HRESULT	Append (LPCITEMIDLIST pidl)
UINT	GetCount () const
IFACEMETHODIMP	Next (ULONG celt, PITEMID_CHILD *rgelt, ULONG *pceltFetched)
IFACEMETHODIMP	Reset ()
IFACEMETHODIMP	Skip (ULONG celt)
IFACEMETHODIMP	Clone (IEnumIDList **ppenum)
	CEnumIDList ()
	~CEnumIDList ()
HRESULT	Initialize ()
STDMETHOD()	Next (ULONG celt, PITEMID_CHILD *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 ()
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 int CALLBACK	DPADestroyCallback (void *pidl, void *pData)
static CEnumIDList *	CreateInstance ()
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
HDPA	m_Items
ULONG	m_Pos

Private Member Functions
BOOL	AddToEnumList (PITEMID_CHILD pidl)

Private Attributes
LPENUMLIST	m_pFirst
LPENUMLIST	m_pLast
LPENUMLIST	m_pCurrent

Additional Inherited Members
Public Types inherited from IEnumIDList
typedef IEnumIDList *	LPENUMIDLIST
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 26 of file cabview.h.

Constructor & Destructor Documentation

CEnumIDList() [1/2]

CEnumIDList::CEnumIDList ( )

inline

Definition at line 41 of file cabview.h.

                  : m_Pos(0)
    {
        m_Items = DPA_Create(0);
    }

~CEnumIDList() [1/2]

CEnumIDList::~CEnumIDList ( )

inlinevirtual

Definition at line 46 of file cabview.h.

    {
        DPA_DestroyCallback(m_Items, DPADestroyCallback, NULL);
    }

CEnumIDList() [2/2]

CEnumIDList::CEnumIDList

(

)

~CEnumIDList() [2/2]

CEnumIDList::~CEnumIDList

(

)

Member Function Documentation

AddToEnumList()

BOOL CEnumIDList::AddToEnumList ( PITEMID_CHILD  pidl )

private

Definition at line 173 of file enumlist.cpp.

{
    LPENUMLIST pNew;
 
    if (!pidl)
        return FALSE;
 
    pNew = static_cast<LPENUMLIST>(SHAlloc(sizeof(ENUMLIST)));
    if (pNew)
    {
        pNew->pNext = NULL;
        pNew->pidl = pidl;
 
        if (!m_pFirst)
        {
            m_pFirst = pNew;
            m_pCurrent = pNew;
        }
 
        if (m_pLast)
        {
            /*add the new item to the end of the list */
            m_pLast->pNext = pNew;
        }
 
        /*update the last item pointer */
        m_pLast = pNew;
        return TRUE;
    }
    return FALSE;
}

Referenced by Initialize().

Append()

HRESULT CEnumIDList::Append ( LPCITEMIDLIST  pidl )

inline

Definition at line 55 of file cabview.h.

    {
        return DPA_AppendPtr(m_Items, (void*)pidl) != DPA_ERR ? S_OK : E_OUTOFMEMORY;
    }

Clone() [1/2]

IFACEMETHODIMP CEnumIDList::Clone ( IEnumIDList **  ppenum )

inline

Implements IEnumIDList.

Definition at line 95 of file cabview.h.

    {
        UNIMPLEMENTED;
        *ppenum = NULL;
        return E_NOTIMPL;
    }

Clone() [2/2]

STDMETHOD() CEnumIDList::Clone ( IEnumIDList **  ppenum )

override

Implements IEnumIDList.

CreateInstance()

static CEnumIDList * CEnumIDList::CreateInstance ( )

inlinestatic

Definition at line 102 of file cabview.h.

    {
        CComPtr<CEnumIDList> obj;
        return SUCCEEDED(ShellObjectCreator(obj)) ? obj.Detach() : NULL;
    }

Referenced by CCabFolder::CreateEnum(), and CCabFolder::EnumObjects().

DPADestroyCallback()

static int CALLBACK CEnumIDList::DPADestroyCallback ( void *  pidl, void *  pData  )

inlinestatic

Definition at line 35 of file cabview.h.

    {
        SHFree(pidl);
        return TRUE;
    }

Referenced by ~CEnumIDList().

Fill() [1/2]

HRESULT CEnumIDList::Fill	(	LPCWSTR	path,
		HWND	hwnd = NULL,
		SHCONTF	contf = 0
	)

Definition at line 215 of file folder.cpp.

{
    FILLCALLBACKDATA data = { this, contf };
    return ExtractCabinet(path, NULL, EnumFillCallback, &data);
}

Referenced by CCabFolder::CreateEnum(), and Fill().

Fill() [2/2]

HRESULT CEnumIDList::Fill	(	PCIDLIST_ABSOLUTE	pidl,
		HWND	hwnd = NULL,
		SHCONTF	contf = 0
	)

Definition at line 221 of file folder.cpp.

{
    WCHAR path[MAX_PATH];
    if (SHGetPathFromIDListW(pidl, path))
        return Fill(path, hwnd, contf);
    return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
}

FindNamedItem()

int CEnumIDList::FindNamedItem

(

PCUITEMID_CHILD

pidl

)

const

Definition at line 171 of file folder.cpp.

{
    CABITEM *needle = (CABITEM*)pidl;
    for (ULONG i = 0, c = GetCount(); i < c; ++i)
    {
        CABITEM *item = (CABITEM*)DPA_FastGetPtr(m_Items, i);
        if (!lstrcmpiW(needle->Path, item->Path))
            return i;
    }
    return -1;
}

GetCount()

UINT CEnumIDList::GetCount ( ) const

inline

Definition at line 60 of file cabview.h.

{ return m_Items ? DPA_GetPtrCount(m_Items) : 0; }

Referenced by FindNamedItem(), Next(), and Skip().

Initialize()

HRESULT CEnumIDList::Initialize

(

)

Definition at line 226 of file enumlist.cpp.

{
    HRESULT hr;
    CComPtr<INetConnectionManager> pNetConMan;
    CComPtr<IEnumNetConnection> pEnumCon;
    ULONG Count;
    PITEMID_CHILD pidl;
 
    /* get an instance to of IConnectionManager */
    hr = CNetConnectionManager_CreateInstance(IID_PPV_ARG(INetConnectionManager, &pNetConMan));
    if (FAILED_UNEXPECTEDLY(hr))
        return S_OK;
 
    hr = pNetConMan->EnumConnections(NCME_DEFAULT, &pEnumCon);
    if (FAILED_UNEXPECTEDLY(hr))
        return S_OK;
 
    while (TRUE)
    {
        CComPtr<INetConnection> INetCon;
 
        hr = pEnumCon->Next(1, &INetCon, &Count);
        if (hr != S_OK)
            break;
 
        pidl = ILCreateNetConnectItem(INetCon);
        if (pidl)
        {
            AddToEnumList(pidl);
        }
    }
 
    return S_OK;
}

Next() [1/2]

HRESULT WINAPI CEnumIDList::Next ( ULONG  celt, PITEMID_CHILD *  rgelt, ULONG *  pceltFetched  )

inline

Implements IEnumIDList.

Definition at line 63 of file cabview.h.

    {
        if (!rgelt)
            return E_INVALIDARG;
        HRESULT hr = S_FALSE;
        UINT count = GetCount(), fetched = 0;
        if (m_Pos < count && fetched < celt)
        {
            if (SUCCEEDED(hr = SHILClone(DPA_FastGetPtr(m_Items, m_Pos), &rgelt[fetched])))
                fetched++;
        }
        if (pceltFetched)
            *pceltFetched = fetched;
        m_Pos += fetched;
        return FAILED(hr) ? hr : (celt == fetched && fetched) ? S_OK : S_FALSE;
    }

Next() [2/2]

STDMETHOD() CEnumIDList::Next ( ULONG  celt, PITEMID_CHILD *  rgelt, ULONG *  pceltFetched  )

override

Implements IEnumIDList.

Reset() [1/2]

HRESULT WINAPI CEnumIDList::Reset ( )

inline

Implements IEnumIDList.

Definition at line 80 of file cabview.h.

    {
        m_Pos = 0;
        return S_OK;
    }

Reset() [2/2]

STDMETHOD() CEnumIDList::Reset ( )

override

Implements IEnumIDList.

Skip() [1/2]

HRESULT WINAPI CEnumIDList::Skip ( ULONG  celt )

inline

Implements IEnumIDList.

Definition at line 86 of file cabview.h.

    {
        UINT count = GetCount(), newpos = m_Pos + celt;
        if (celt > count || newpos >= count)
            return E_INVALIDARG;
        m_Pos = newpos;
        return S_OK;
    }

Skip() [2/2]

STDMETHOD() CEnumIDList::Skip ( ULONG  celt )

override

Implements IEnumIDList.

Member Data Documentation

m_Items

HDPA CEnumIDList::m_Items

protected

Definition at line 31 of file cabview.h.

Referenced by Append(), CEnumIDList(), FindNamedItem(), GetCount(), Next(), and ~CEnumIDList().

m_pCurrent

LPENUMLIST CEnumIDList::m_pCurrent

private

Definition at line 158 of file enumlist.cpp.

Referenced by AddToEnumList().

m_pFirst

LPENUMLIST CEnumIDList::m_pFirst

private

Definition at line 156 of file enumlist.cpp.

Referenced by AddToEnumList().

m_pLast

LPENUMLIST CEnumIDList::m_pLast

private

Definition at line 157 of file enumlist.cpp.

Referenced by AddToEnumList().

m_Pos

ULONG CEnumIDList::m_Pos

protected

Definition at line 32 of file cabview.h.

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

---

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

• dll/shellext/cabview/cabview.h
• dll/shellext/netshell/enumlist.cpp
• dll/shellext/cabview/folder.cpp