CFolderItems Class Reference

#include <CFolderItems.h>

Inheritance diagram for CFolderItems:

Collaboration diagram for CFolderItems:

Public Member Functions
	CFolderItems ()
	~CFolderItems ()
HRESULT	Initialize (LPCITEMIDLIST idlist, Folder *parent)
HWND	GetHwnd ()
IUnknown *	GetSite ()
STDMETHOD()	get_Count (long *plCount) override
STDMETHOD()	get_Application (IDispatch **ppid) override
STDMETHOD()	get_Parent (IDispatch **ppid) override
STDMETHOD()	Item (VARIANT index, FolderItem **ppid) override
STDMETHOD()	_NewEnum (IUnknown **ppunk) override
STDMETHOD()	InvokeVerbEx (VARIANT vVerb, VARIANT vArgs) override
STDMETHOD()	Filter (LONG grfFlags, BSTR bstrFilter) override
STDMETHOD()	get_Verbs (FolderItemVerbs **ppfic) 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 ()

Static Public Member Functions
static HRESULT	InvokeVerbHelper (HWND hWnd, IContextMenu &cm, VARIANT &vVerb, VARIANT &vArgs, IUnknown *pSite)
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)

Private Member Functions
void	ResetEnum ()
BOOL	IncludeItem (LPCITEMIDLIST pidl)
HRESULT	EnumObjects ()
HRESULT	GetNext (LPITEMIDLIST *ppidl)

Static Private Member Functions
static HRESULT CALLBACK	ItemsEnumFilter (void *Cookie, LPCITEMIDLIST pidl)

Private Attributes
CComHeapPtr< ITEMIDLIST >	m_idlist
CComPtr< IEnumIDList >	m_EnumIDList
CComPtr< Folder >	m_Folder
long	m_Count
LONG	m_Contf = SHCONTF_FOLDERS | SHCONTF_NONFOLDERS
BSTR	m_bstrFilter = NULL

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

Detailed Description

Definition at line 77 of file CFolderItems.h.

Constructor & Destructor Documentation

CFolderItems()

CFolderItems::CFolderItems

(

)

Definition at line 419 of file CFolderItems.cpp.

    :m_Count(-1)
{
}

~CFolderItems()

CFolderItems::~CFolderItems

(

)

Definition at line 424 of file CFolderItems.cpp.

{
    SysFreeString(m_bstrFilter);
}

Member Function Documentation

_NewEnum()

HRESULT STDMETHODCALLTYPE CFolderItems::_NewEnum ( IUnknown **  ppunk )

override

Definition at line 591 of file CFolderItems.cpp.

{
    return ShellObjectCreatorInit<CFolderItems>(static_cast<LPITEMIDLIST>(m_idlist), m_Folder, IID_FolderItems, reinterpret_cast<void**>(ppunk));
}

EnumObjects()

HRESULT CFolderItems::EnumObjects ( )

private

Definition at line 460 of file CFolderItems.cpp.

{
    if (m_EnumIDList)
        return S_OK;
 
    CComPtr<IShellFolder> psf;
    HRESULT hr = SHBindToObject(NULL, m_idlist, NULL, IID_PPV_ARG(IShellFolder, &psf));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    CComPtr<IEnumIDList> pEnum;
    if (FAILED(hr = psf->EnumObjects(NULL, m_Contf, &pEnum)))
        return hr;
    hr = pEnum ? S_OK : E_UNEXPECTED;
    if (SUCCEEDED(hr) && m_bstrFilter)
    {
        CComPtr<IEnumIDList> pFilteredEnum;
        hr = CEnumIDListBase::CreateInstance(*pEnum, ItemsEnumFilter, this, &pFilteredEnum);
        if (SUCCEEDED(hr))
            pEnum = pFilteredEnum;
    }
 
    if (FAILED(hr))
        return hr;
    m_EnumIDList = pEnum;
    return S_OK;
}

Referenced by get_Count(), and Item().

Filter()

HRESULT STDMETHODCALLTYPE CFolderItems::Filter ( LONG  grfFlags, BSTR  bstrFilter  )

override

Definition at line 605 of file CFolderItems.cpp.

{
    if (bstrFilter)
    {
        if (!*bstrFilter)
            bstrFilter = NULL;
        else if ((bstrFilter = SysAllocString(bstrFilter)) == NULL)
            return E_OUTOFMEMORY;
    }
    ResetEnum();
    SysFreeString(m_bstrFilter);
    m_bstrFilter = bstrFilter;
    m_Contf = grfFlags;
    return S_OK;
}

get_Application()

HRESULT STDMETHODCALLTYPE CFolderItems::get_Application ( IDispatch **  ppid )

override

Definition at line 517 of file CFolderItems.cpp.

{
    TRACE("(%p, %p)\n", this, ppid);
    return m_Folder->get_Application(ppid);
}

get_Count()

HRESULT STDMETHODCALLTYPE CFolderItems::get_Count ( long *  plCount )

override

Definition at line 489 of file CFolderItems.cpp.

{
    if (!plCount)
        return E_POINTER;
 
    if (m_Count == -1)
    {
        long count = 0;
 
        if (FAILED(EnumObjects()))
            return E_FAIL;
        HRESULT hr = m_EnumIDList->Reset();
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        CComHeapPtr<ITEMIDLIST> Pidl;
        while ((hr = GetNext(&Pidl)) == S_OK)
        {
            count++;
            Pidl.Free();
        }
        m_Count = count;
    }
    *plCount = m_Count;
 
    return S_OK;
}

Referenced by get_Verbs().

get_Parent()

HRESULT STDMETHODCALLTYPE CFolderItems::get_Parent ( IDispatch **  ppid )

override

Definition at line 523 of file CFolderItems.cpp.

{
    TRACE("(%p, %p)\n", this, ppid);
 
    if (ppid)
        *ppid = NULL;
 
    return E_NOTIMPL;
}

get_Verbs()

HRESULT STDMETHODCALLTYPE CFolderItems::get_Verbs ( FolderItemVerbs **  ppfic )

override

Definition at line 621 of file CFolderItems.cpp.

{
    if (!ppfic)
        return E_POINTER;
 
    CComPtr<CFolderItemVerbs> pVerbs;
    HRESULT hr = CFolderItemVerbs::CreateInstance(pVerbs);
    if (FAILED(hr))
        return hr;
    long count;
    if (SUCCEEDED(hr = get_Count(&count)) && count)
    {
        CComPtr<IContextMenu> pCM;
        if (SUCCEEDED(hr = GetUIObjectOfFolderItems(this, IID_PPV_ARG(IContextMenu, &pCM))))
            hr = pVerbs->Init(*static_cast<IContextMenu*>(pCM));
    }
    *ppfic = pVerbs.Detach();
    return S_OK;
}

GetHwnd()

HWND CFolderItems::GetHwnd ( )

inline

Definition at line 101 of file CFolderItems.h.

{ return NULL; }

Referenced by InvokeVerbEx().

GetNext()

HRESULT CFolderItems::GetNext ( LPITEMIDLIST *  ppidl )

inlineprivate

Definition at line 94 of file CFolderItems.h.

{ return m_EnumIDList->Next(1, ppidl, NULL); }

Referenced by get_Count(), and Item().

GetSite()

IUnknown * CFolderItems::GetSite ( )

inline

Definition at line 102 of file CFolderItems.h.

{ return NULL; }

Referenced by InvokeVerbEx().

IncludeItem()

BOOL CFolderItems::IncludeItem ( LPCITEMIDLIST  pidl )

private

Definition at line 441 of file CFolderItems.cpp.

{
    if (!m_bstrFilter)
        return TRUE;
 
    CComHeapPtr<ITEMIDLIST> pidlFull;
    if (FAILED(SHILCombine(m_idlist, pidl, &pidlFull)))
        return FALSE;
    CComHeapPtr<WCHAR> pszPath;
    if (FAILED(SHELL_DisplayNameOf(NULL, pidlFull, SHGDN_FORPARSING | SHGDN_INFOLDER, &pszPath)))
        return FALSE;
    return PathMatchSpecW(pszPath, m_bstrFilter);
}

Initialize()

HRESULT CFolderItems::Initialize	(	LPCITEMIDLIST	idlist,
		Folder *	parent
	)

Definition at line 429 of file CFolderItems.cpp.

{
    m_Folder = parent;
    return SHILClone(idlist, &m_idlist);
}

InvokeVerbEx()

HRESULT STDMETHODCALLTYPE CFolderItems::InvokeVerbEx ( VARIANT  vVerb, VARIANT  vArgs  )

override

Definition at line 596 of file CFolderItems.cpp.

{
    CComPtr<IContextMenu> pCM;
    HRESULT hr = GetUIObjectOfFolderItems(this, IID_PPV_ARG(IContextMenu, &pCM));
    if (FAILED(hr))
        return hr == HRESULT_FROM_WIN32(ERROR_NO_DATA) ? S_FALSE : hr;
    return InvokeVerbHelper(GetHwnd(), *pCM, vVerb, vArgs, GetSite());
}

InvokeVerbHelper()

HRESULT CFolderItems::InvokeVerbHelper ( HWND  hWnd, IContextMenu &  cm, VARIANT &  vVerb, VARIANT &  vArgs, IUnknown *  pSite  )

static

Definition at line 641 of file CFolderItems.cpp.

{
    PCWSTR pszVerb = V_VT(&vVerb) == VT_BSTR && !StrIsNullOrEmpty(V_BSTR(&vVerb)) ? V_BSTR(&vVerb) : NULL;
    PCWSTR pszArgs = V_VT(&vArgs) == VT_BSTR && !StrIsNullOrEmpty(V_BSTR(&vArgs)) ? V_BSTR(&vArgs) : NULL;
    HRESULT hr = SHELL_InvokeCommandOnContextMenu(hWnd, &cm, pszVerb, !!pszVerb, pszArgs, 0, 0, pSite);
    return SUCCEEDED(hr) ? hr : S_FALSE;
}

Referenced by CFolderItem::InvokeVerbEx(), and InvokeVerbEx().

Item()

HRESULT STDMETHODCALLTYPE CFolderItems::Item ( VARIANT  index, FolderItem **  ppid  )

override

Definition at line 533 of file CFolderItems.cpp.

{
    CComVariant index;
    HRESULT hr;
 
    hr = VariantCopyInd(&index, &var);
    if (FAILED(hr))
        return hr;
 
    if (V_VT(&index) == VT_I2)
        VariantChangeType(&index, &index, 0, VT_I4);
 
    if (V_VT(&index) == VT_I4)
    {
        if (FAILED(EnumObjects()))
            return E_FAIL;
 
        ULONG count = V_UI4(&index);
 
        hr = m_EnumIDList->Reset();
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        hr = m_EnumIDList->Skip(count);
 
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        CComHeapPtr<ITEMIDLIST> pidlChild;
        hr = GetNext(&pidlChild);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
        if (hr != S_OK)
            return E_INVALIDARG;
 
        CComHeapPtr<ITEMIDLIST> pidlFull;
        if (FAILED_UNEXPECTEDLY(hr = SHILCombine(m_idlist, pidlChild, &pidlFull)))
            return hr;
        hr = ShellObjectCreatorInit<CFolderItem>(m_Folder, pidlFull, IID_PPV_ARG(FolderItem, ppid));
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
        return hr;
    }
    else if (V_VT(&index) == VT_BSTR)
    {
        if (!V_BSTR(&index))
            return S_FALSE;
 
        hr = m_Folder->ParseName(V_BSTR(&index), ppid);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
        return hr;
    }
 
    FIXME("Index type %d not handled.\n", V_VT(&index));
    return E_NOTIMPL;
}

ItemsEnumFilter()

HRESULT CALLBACK CFolderItems::ItemsEnumFilter ( void *  Cookie, LPCITEMIDLIST  pidl  )

staticprivate

Definition at line 455 of file CFolderItems.cpp.

{
    return ((CFolderItems*)Cookie)->IncludeItem(pidl) ? S_OK : S_FALSE;
}

Referenced by EnumObjects().

ResetEnum()

void CFolderItems::ResetEnum ( )

private

Definition at line 435 of file CFolderItems.cpp.

{
    m_EnumIDList = NULL;
    m_Count = -1;
}

Referenced by Filter().

Member Data Documentation

m_bstrFilter

BSTR CFolderItems::m_bstrFilter = NULL

private

Definition at line 88 of file CFolderItems.h.

Referenced by EnumObjects(), Filter(), IncludeItem(), and ~CFolderItems().

m_Contf

LONG CFolderItems::m_Contf = SHCONTF_FOLDERS | SHCONTF_NONFOLDERS

private

Definition at line 87 of file CFolderItems.h.

Referenced by EnumObjects(), and Filter().

m_Count

long CFolderItems::m_Count

private

Definition at line 86 of file CFolderItems.h.

Referenced by get_Count(), and ResetEnum().

m_EnumIDList

CComPtr<IEnumIDList> CFolderItems::m_EnumIDList

private

Definition at line 84 of file CFolderItems.h.

Referenced by EnumObjects(), get_Count(), Item(), and ResetEnum().

m_Folder

CComPtr<Folder> CFolderItems::m_Folder

private

Definition at line 85 of file CFolderItems.h.

Referenced by _NewEnum(), get_Application(), Initialize(), and Item().

m_idlist

CComHeapPtr<ITEMIDLIST> CFolderItems::m_idlist

private

Definition at line 83 of file CFolderItems.h.

Referenced by _NewEnum(), EnumObjects(), IncludeItem(), Initialize(), and Item().

---

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

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