CShellItem Class Reference

#include <CShellItem.h>

Inheritance diagram for CShellItem:

Collaboration diagram for CShellItem:

Public Member Functions
	CShellItem ()
	~CShellItem ()
HRESULT	get_parent_pidl (LPITEMIDLIST *parent_pidl)
HRESULT	get_parent_shellfolder (IShellFolder **ppsf)
HRESULT	get_shellfolder (IBindCtx *pbc, REFIID riid, void **ppvOut)
STDMETHOD()	BindToHandler (IBindCtx *pbc, REFGUID rbhid, REFIID riid, void **ppvOut) override
STDMETHOD()	GetParent (IShellItem **ppsi) override
STDMETHOD()	GetDisplayName (SIGDN sigdnName, LPWSTR *ppszName) override
STDMETHOD()	GetAttributes (SFGAOF sfgaoMask, SFGAOF *psfgaoAttribs) override
STDMETHOD()	Compare (IShellItem *oth, SICHINTF hint, int *piOrder) override
STDMETHOD()	GetClassID (CLSID *pClassID) override
STDMETHOD()	SetIDList (PCIDLIST_ABSOLUTE pidl) override
STDMETHOD()	GetIDList (PIDLIST_ABSOLUTE *ppidl) 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	BindToHandler ([in] IBindCtx *pbc, [in] REFGUID rbhid, [in] REFIID riid, [out, iid_is(riid)] void **ppvOut)
HRESULT	GetParent ([out] IShellItem **ppsi)
HRESULT	GetDisplayName ([in] SIGDN sigdnName, [out] LPWSTR *ppszName)
HRESULT	GetAttributes ([in] SFGAOF sfgaoMask, [out] SFGAOF *psfgaoAttribs)
HRESULT	Compare ([in] IShellItem *psi, [in] SICHINTF hint, [out] int *piOrder)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()
HRESULT	SetIDList ([in] PCIDLIST_ABSOLUTE pidl)
HRESULT	GetIDList ([out] PIDLIST_ABSOLUTE *ppidl)
HRESULT	GetClassID ([out] CLSID *pClassID)

Private Attributes
LPITEMIDLIST	m_pidl

Additional Inherited Members
Public Types inherited from IShellItem
enum	SIGDN {   SIGDN_NORMALDISPLAY = 0 , SIGDN_PARENTRELATIVEPARSING = 0x80018001 , SIGDN_DESKTOPABSOLUTEPARSING = 0x80028000 , SIGDN_PARENTRELATIVEEDITING = 0x80031001 ,   SIGDN_DESKTOPABSOLUTEEDITING = 0x8004c000 , SIGDN_FILESYSPATH = 0x80058000 , SIGDN_URL = 0x80068000 , SIGDN_PARENTRELATIVEFORADDRESSBAR = 0x8007c001 ,   SIGDN_PARENTRELATIVE = 0x80080001 }
enum	_SICHINTF { SICHINT_DISPLAY = 0x00000000 , SICHINT_CANONICAL = 0x10000000 , SICHINT_TEST_FILESYSPATH_IF_NOT_EQUAL = 0x20000000 , SICHINT_ALLFIELDS = 0x80000000 }
typedef DWORD	SICHINTF
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Types inherited from IPersist
typedef IPersist *	LPPERSIST
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 25 of file CShellItem.h.

Constructor & Destructor Documentation

CShellItem()

CShellItem::CShellItem

(

)

Definition at line 27 of file CShellItem.cpp.

                       :
    m_pidl(NULL)
{
}

~CShellItem()

CShellItem::~CShellItem

(

)

Definition at line 32 of file CShellItem.cpp.

{
    ILFree(m_pidl);
}

Member Function Documentation

BindToHandler()

HRESULT WINAPI CShellItem::BindToHandler ( IBindCtx *  pbc, REFGUID  rbhid, REFIID  riid, void **  ppvOut  )

override

Implements IShellItem.

Definition at line 98 of file CShellItem.cpp.

{
    HRESULT ret;
    TRACE("(%p, %p,%s,%p,%p)\n", this, pbc, shdebugstr_guid(&rbhid), riid, ppvOut);
 
    *ppvOut = NULL;
    if (IsEqualGUID(rbhid, BHID_SFObject))
    {
        return get_shellfolder(pbc, riid, ppvOut);
    }
    else if (IsEqualGUID(rbhid, BHID_SFUIObject))
    {
        CComPtr<IShellFolder> psf_parent;
        if (_ILIsDesktop(m_pidl))
            ret = SHGetDesktopFolder(&psf_parent);
        else
            ret = get_parent_shellfolder(&psf_parent);
        if (FAILED_UNEXPECTEDLY(ret))
            return ret;
 
        LPCITEMIDLIST pidl = ILFindLastID(m_pidl);
        return psf_parent->GetUIObjectOf(NULL, 1, &pidl, riid, NULL, ppvOut);
    }
    else if (IsEqualGUID(rbhid, BHID_DataObject))
    {
        return BindToHandler(pbc, BHID_SFUIObject, IID_IDataObject, ppvOut);
    }
    else if (IsEqualGUID(rbhid, BHID_SFViewObject))
    {
        CComPtr<IShellFolder> psf;
        ret = get_shellfolder(NULL, IID_PPV_ARG(IShellFolder, &psf));
        if (FAILED_UNEXPECTEDLY(ret))
            return ret;
 
        return psf->CreateViewObject(NULL, riid, ppvOut);
    }
 
    FIXME("Unsupported BHID %s.\n", debugstr_guid(&rbhid));
 
    return MK_E_NOOBJECT;
}

Referenced by BindToHandler().

Compare()

HRESULT WINAPI CShellItem::Compare ( IShellItem *  oth, SICHINTF  hint, int *  piOrder  )

override

Implements IShellItem.

Definition at line 188 of file CShellItem.cpp.

{
    HRESULT hr;
    CComPtr<IPersistIDList>      pIDList;
    CComPtr<IShellFolder>        psfDesktop;
    LPITEMIDLIST pidl;
 
    TRACE("(%p,%p,%x,%p)\n", this, oth, hint, piOrder);
 
    if (piOrder == NULL || oth == NULL)
        return E_POINTER;
 
    hr = oth->QueryInterface(IID_PPV_ARG(IPersistIDList, &pIDList));
    if (SUCCEEDED(hr))
    {
        hr = pIDList->GetIDList(&pidl);
        if (SUCCEEDED(hr))
        {
            hr = SHGetDesktopFolder(&psfDesktop);
            if (SUCCEEDED(hr))
            {
                hr = psfDesktop->CompareIDs(hint, m_pidl, pidl);
                *piOrder = (int)(short)SCODE_CODE(hr);
            }
            ILFree(pidl);
        }
    }
 
    if(FAILED(hr))
        return hr;
 
    if(*piOrder)
        return S_FALSE;
    else
        return S_OK;
}

get_parent_pidl()

HRESULT CShellItem::get_parent_pidl

(

LPITEMIDLIST *

parent_pidl

)

Definition at line 37 of file CShellItem.cpp.

{
    *parent_pidl = ILClone(m_pidl);
    if (*parent_pidl)
    {
        if (ILRemoveLastID(*parent_pidl))
            return S_OK;
        else
        {
            ILFree(*parent_pidl);
            *parent_pidl = NULL;
            return E_INVALIDARG;
        }
    }
    else
    {
        *parent_pidl = NULL;
        return E_OUTOFMEMORY;
    }
}

Referenced by get_parent_shellfolder(), and GetParent().

get_parent_shellfolder()

HRESULT CShellItem::get_parent_shellfolder

(

IShellFolder **

ppsf

)

Definition at line 58 of file CShellItem.cpp.

{
    HRESULT hr;
    LPITEMIDLIST parent_pidl;
    CComPtr<IShellFolder>        desktop;
 
    hr = get_parent_pidl(&parent_pidl);
    if (SUCCEEDED(hr))
    {
        hr = SHGetDesktopFolder(&desktop);
        if (SUCCEEDED(hr))
            hr = desktop->BindToObject(parent_pidl, NULL, IID_PPV_ARG(IShellFolder, ppsf));
        ILFree(parent_pidl);
    }
 
    return hr;
}

Referenced by BindToHandler(), and GetAttributes().

get_shellfolder()

HRESULT CShellItem::get_shellfolder	(	IBindCtx *	pbc,
		REFIID	riid,
		void **	ppvOut
	)

Definition at line 76 of file CShellItem.cpp.

{
    CComPtr<IShellFolder> psf;
    CComPtr<IShellFolder> psfDesktop;
    HRESULT ret;
 
    ret = SHGetDesktopFolder(&psfDesktop);
    if (FAILED_UNEXPECTEDLY(ret))
        return ret;
 
    if (_ILIsDesktop(m_pidl))
        psf = psfDesktop;
    else
    {
        ret = psfDesktop->BindToObject(m_pidl, pbc, IID_PPV_ARG(IShellFolder, &psf));
        if (FAILED_UNEXPECTEDLY(ret))
            return ret;
    }
 
    return psf->QueryInterface(riid, ppvOut);
}

Referenced by BindToHandler().

GetAttributes()

HRESULT WINAPI CShellItem::GetAttributes ( SFGAOF  sfgaoMask, SFGAOF *  psfgaoAttribs  )

override

Implements IShellItem.

Definition at line 162 of file CShellItem.cpp.

{
    CComPtr<IShellFolder>        parent_folder;
    LPCITEMIDLIST child_pidl;
    HRESULT hr;
 
    TRACE("(%p,%x,%p)\n", this, sfgaoMask, psfgaoAttribs);
 
    if (_ILIsDesktop(m_pidl))
        hr = SHGetDesktopFolder(&parent_folder);
    else
        hr = get_parent_shellfolder(&parent_folder);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    child_pidl = ILFindLastID(m_pidl);
    *psfgaoAttribs = sfgaoMask;
    hr = parent_folder->GetAttributesOf(1, &child_pidl, psfgaoAttribs);
    *psfgaoAttribs &= sfgaoMask;
 
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return (sfgaoMask == *psfgaoAttribs) ? S_OK : S_FALSE;
}

GetClassID()

HRESULT WINAPI CShellItem::GetClassID ( CLSID *  pClassID )

override

Implements IPersist.

Definition at line 225 of file CShellItem.cpp.

{
    TRACE("(%p,%p)\n", this, pClassID);
 
    *pClassID = CLSID_ShellItem;
    return S_OK;
}

GetDisplayName()

HRESULT WINAPI CShellItem::GetDisplayName ( SIGDN  sigdnName, LPWSTR *  ppszName  )

override

Implements IShellItem.

Definition at line 157 of file CShellItem.cpp.

{
    return SHGetNameFromIDList(m_pidl, sigdnName, ppszName);
}

GetIDList()

HRESULT WINAPI CShellItem::GetIDList ( PIDLIST_ABSOLUTE *  ppidl )

override

Implements IPersistIDList.

Definition at line 250 of file CShellItem.cpp.

{
    TRACE("(%p,%p)\n", this, ppidl);
 
    *ppidl = ILClone(m_pidl);
    if (*ppidl)
        return S_OK;
    else
        return E_OUTOFMEMORY;
}

GetParent()

HRESULT WINAPI CShellItem::GetParent ( IShellItem **  ppsi )

override

Implements IShellItem.

Definition at line 140 of file CShellItem.cpp.

{
    HRESULT hr;
    LPITEMIDLIST parent_pidl;
 
    TRACE("(%p,%p)\n", this, ppsi);
 
    hr = get_parent_pidl(&parent_pidl);
    if (SUCCEEDED(hr))
    {
        hr = SHCreateShellItem(NULL, NULL, parent_pidl, ppsi);
        ILFree(parent_pidl);
    }
 
    return hr;
}

SetIDList()

HRESULT WINAPI CShellItem::SetIDList ( PCIDLIST_ABSOLUTE  pidl )

override

Implements IPersistIDList.

Definition at line 233 of file CShellItem.cpp.

{
    LPITEMIDLIST new_pidl;
 
    TRACE("(%p,%p)\n", this, pidlx);
 
    new_pidl = ILClone(pidlx);
    if (new_pidl)
    {
        ILFree(m_pidl);
        m_pidl = new_pidl;
        return S_OK;
    }
    else
        return E_OUTOFMEMORY;
}

Member Data Documentation

m_pidl

LPITEMIDLIST CShellItem::m_pidl

private

Definition at line 32 of file CShellItem.h.

Referenced by BindToHandler(), Compare(), get_parent_pidl(), get_shellfolder(), GetAttributes(), GetDisplayName(), GetIDList(), SetIDList(), and ~CShellItem().

---

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

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