#include <foldercommon.h>

Inheritance diagram for CCommonFolder< TSelf, TItemId, TExtractIcon >:

[legend]

Collaboration diagram for CCommonFolder< TSelf, TItemId, TExtractIcon >:

[legend]

Public Member Functions
	CCommonFolder ()

virtual	~CCommonFolder ()

virtual HRESULT STDMETHODCALLTYPE	ParseDisplayName (HWND hwndOwner, LPBC pbcReserved, LPOLESTR lpszDisplayName, ULONG pchEaten, LPITEMIDLIST ppidl, ULONG *pdwAttributes)

virtual HRESULT STDMETHODCALLTYPE	EnumObjects (HWND hwndOwner, SHCONTF grfFlags, IEnumIDList **ppenumIDList) PURE

virtual HRESULT STDMETHODCALLTYPE	BindToObject (LPCITEMIDLIST pidl, LPBC pbcReserved, REFIID riid, void **ppvOut)

virtual HRESULT STDMETHODCALLTYPE	BindToStorage (LPCITEMIDLIST pidl, LPBC pbcReserved, REFIID riid, void **ppvObj)

virtual HRESULT STDMETHODCALLTYPE	CompareIDs (LPARAM lParam, LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)

virtual HRESULT STDMETHODCALLTYPE	CreateViewObject (HWND hwndOwner, REFIID riid, void **ppvOut)

virtual HRESULT STDMETHODCALLTYPE	GetAttributesOf (UINT cidl, PCUITEMID_CHILD_ARRAY apidl, SFGAOF *rgfInOut)

virtual HRESULT STDMETHODCALLTYPE	GetUIObjectOf (HWND hwndOwner, UINT cidl, PCUITEMID_CHILD_ARRAY apidl, REFIID riid, UINT prgfInOut, void *ppvOut)

virtual HRESULT STDMETHODCALLTYPE	GetDisplayNameOf (LPCITEMIDLIST pidl, SHGDNF uFlags, STRRET *lpName)

virtual HRESULT STDMETHODCALLTYPE	SetNameOf (HWND hwnd, LPCITEMIDLIST pidl, LPCOLESTR lpszName, SHGDNF uFlags, LPITEMIDLIST *ppidlOut)

virtual HRESULT STDMETHODCALLTYPE	GetDefaultSearchGUID (GUID *lpguid)

virtual HRESULT STDMETHODCALLTYPE	EnumSearches (IEnumExtraSearch **ppenum)

virtual HRESULT STDMETHODCALLTYPE	GetDefaultColumn (DWORD dwReserved, ULONG pSort, ULONG pDisplay)

virtual HRESULT STDMETHODCALLTYPE	GetDefaultColumnState (UINT iColumn, SHCOLSTATEF *pcsFlags) PURE

virtual HRESULT STDMETHODCALLTYPE	GetDetailsEx (LPCITEMIDLIST pidl, const SHCOLUMNID pscid, VARIANT pv) PURE

virtual HRESULT STDMETHODCALLTYPE	GetDetailsOf (LPCITEMIDLIST pidl, UINT iColumn, SHELLDETAILS *psd) PURE

virtual HRESULT STDMETHODCALLTYPE	MapColumnToSCID (UINT iColumn, SHCOLUMNID *pscid) PURE

virtual HRESULT STDMETHODCALLTYPE	GetClassID (CLSID *lpClassId)

virtual HRESULT STDMETHODCALLTYPE	Initialize (PCIDLIST_ABSOLUTE pidl)

virtual HRESULT STDMETHODCALLTYPE	GetCurFolder (PIDLIST_ABSOLUTE *pidl)

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 IShellFolder2
HRESULT	GetDetailsEx ([in] PCUITEMID_CHILD pidl, [in] const SHCOLUMNID pscid, [out] VARIANT pv)

HRESULT	GetDetailsOf ([in] PCUITEMID_CHILD pidl, [in] UINT iColumn, [out] SHELLDETAILS *psd)

Public Member Functions inherited from IShellFolder
HRESULT	ParseDisplayName ([in] HWND hwndOwner, [in] LPBC pbcReserved, [in, string] LPOLESTR lpszDisplayName, [out] ULONG pchEaten, [out] PIDLIST_RELATIVE ppidl, [in, out, unique] ULONG *pdwAttributes)

HRESULT	BindToObject ([in] PCUIDLIST_RELATIVE pidl, [in] LPBC pbcReserved, [in] REFIID riid, [out, iid_is(riid)] void **ppvOut)

HRESULT	BindToStorage ([in] PCUIDLIST_RELATIVE pidl, [in] LPBC pbcReserved, [in] REFIID riid, [out, iid_is(riid)] void **ppvObj)

HRESULT	CompareIDs ([in] LPARAM lParam, [in] PCUIDLIST_RELATIVE pidl1, [in] PCUIDLIST_RELATIVE pidl2)

HRESULT	GetDisplayNameOf ([in] PCUITEMID_CHILD pidl, [in] SHGDNF uFlags, [out] STRRET *lpName)

HRESULT	SetNameOf ([in] HWND hwnd, [in] PCUITEMID_CHILD pidl, [in, string] LPCOLESTR lpszName, [in] SHGDNF uFlags, [out] PITEMID_CHILD *ppidlOut)

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 CALLBACK	DefCtxMenuCallback (IShellFolder , HWND, IDataObject , UINT uMsg, WPARAM, LPARAM)

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 Member Functions
virtual HRESULT STDMETHODCALLTYPE	InternalBindToObject (PWSTR path, const TItemId info, LPITEMIDLIST first, LPCITEMIDLIST rest, LPITEMIDLIST fullPidl, LPBC pbcReserved, IShellFolder *ppsfChild) PURE

virtual HRESULT STDMETHODCALLTYPE	ResolveSymLink (const TItemId info, LPITEMIDLIST fullPidl)

virtual HRESULT STDMETHODCALLTYPE	CompareName (LPARAM lParam, const TItemId first, const TItemId second)

virtual HRESULT STDMETHODCALLTYPE	CompareIDs (LPARAM lParam, const TItemId first, const TItemId second) PURE

virtual ULONG STDMETHODCALLTYPE	ConvertAttributes (const TItemId *entry, PULONG inMask) PURE

virtual BOOL STDMETHODCALLTYPE	IsFolder (LPCITEMIDLIST pcidl)

virtual BOOL STDMETHODCALLTYPE	IsFolder (const TItemId *info) PURE

virtual BOOL STDMETHODCALLTYPE	IsSymLink (LPCITEMIDLIST pcidl)

virtual BOOL STDMETHODCALLTYPE	IsSymLink (const TItemId *info)

virtual HRESULT	GetInfoFromPidl (LPCITEMIDLIST pcidl, const TItemId **pentry) PURE

Protected Attributes
WCHAR	m_NtPath [MAX_PATH]

LPITEMIDLIST	m_shellPidl

Additional Inherited Members
Public Types inherited from IShellFolder2
typedef struct IShellFolder2::SHCOLUMNID *	LPSHCOLUMNID

typedef const SHCOLUMNID *	LPCSHCOLUMNID

Public Types inherited from IShellFolder
enum	tagSHGDN { SHGDN_NORMAL = 0, SHGDN_INFOLDER = 1, SHGDN_FOREDITING = 0x1000, SHGDN_INCLUDE_NONFILESYS = 0x2000, SHGDN_FORADDRESSBAR = 0x4000, SHGDN_FORPARSING = 0x8000 }

enum	tagSHCONTF { SHCONTF_FOLDERS = 32, SHCONTF_NONFOLDERS = 64, SHCONTF_INCLUDEHIDDEN = 128, SHCONTF_INIT_ON_FIRST_NEXT = 256, SHCONTF_NETPRINTERSRCH = 512, SHCONTF_SHAREABLE = 1024, SHCONTF_STORAGE = 2048, SHCONTF_NAVIGATION_ENUM = 0x01000, SHCONTF_FASTITEMS = 0x02000, SHCONTF_FLATLIST = 0x04000, SHCONTF_ENABLE_ASYNC = 0x08000, SHCONTF_INCLUDESUPERHIDDEN = 0x10000 }

typedef IShellFolder *	LPSHELLFOLDER

typedef enum IShellFolder::tagSHGDN	SHGNO

typedef DWORD	SHGDNF

typedef DWORD	SHCONTF

Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Public Types inherited from IPersistFolder2
typedef IPersistFolder2 *	LPPERSISTFOLDER2

Public Types inherited from IPersistFolder
typedef IPersistFolder *	LPPERSISTFOLDER

Public Types inherited from IPersist
typedef IPersist *	LPPERSIST

Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Public Attributes inherited from IShellFolder
SFGAO_PKEYSFGAOMASK typedef ULONG	SFGAOF

Detailed Description

template<class TSelf, typename TItemId, class TExtractIcon>
class CCommonFolder< TSelf, TItemId, TExtractIcon >

Definition at line 58 of file foldercommon.h.

Constructor & Destructor Documentation

◆ CCommonFolder()

template<class TSelf, typename TItemId, class TExtractIcon>

CCommonFolder< TSelf, TItemId, TExtractIcon >::CCommonFolder ( )

inline

Definition at line 70 of file foldercommon.h.

                     :
         m_shellPidl(NULL)
     {
     }

◆ ~CCommonFolder()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual CCommonFolder< TSelf, TItemId, TExtractIcon >::~CCommonFolder ( )

inlinevirtual

Definition at line 75 of file foldercommon.h.

     {
         if (m_shellPidl)
             ILFree(m_shellPidl);
     }

Member Function Documentation

◆ BindToObject()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::BindToObject	(	LPCITEMIDLIST	pidl,
		LPBC	pbcReserved,
		REFIID	riid,
		void **	ppvOut
	)

inlinevirtual

Definition at line 166 of file foldercommon.h.

     {
         const TItemId * info;
 
         if (IsEqualIID(riid, IID_IShellFolder))
         {
             HRESULT hr = GetInfoFromPidl(pidl, &info);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             WCHAR path[MAX_PATH];
 
             StringCbCopyW(path, sizeof(path), m_NtPath);
             PathAppendW(path, info->entryName);
 
             LPITEMIDLIST first = ILCloneFirst(pidl);
             LPCITEMIDLIST rest = ILGetNext(pidl);
 
             LPITEMIDLIST fullPidl = ILCombine(m_shellPidl, first);
 
             CComPtr<IShellFolder> psfChild;
             hr = InternalBindToObject(path, info, first, rest, fullPidl, pbcReserved, &psfChild);
 
             ILFree(fullPidl);
             ILFree(first);
 
             if (FAILED(hr))
                 return hr;
 
             if (hr == S_FALSE)
                 return S_OK;
 
             if (rest->mkid.cb > 0)
             {
                 return psfChild->BindToObject(rest, pbcReserved, riid, ppvOut);
             }
 
             return psfChild->QueryInterface(riid, ppvOut);
         }
 
         return E_NOTIMPL;
     }

◆ BindToStorage()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::BindToStorage	(	LPCITEMIDLIST	pidl,
		LPBC	pbcReserved,
		REFIID	riid,
		void **	ppvObj
	)

inlinevirtual

Definition at line 232 of file foldercommon.h.

     {
         UNIMPLEMENTED;
         return E_NOTIMPL;
     }

◆ CompareIDs() [1/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::CompareIDs	(	LPARAM	lParam,
		LPCITEMIDLIST	pidl1,
		LPCITEMIDLIST	pidl2
	)

inlinevirtual

Definition at line 242 of file foldercommon.h.

     {
         HRESULT hr;
 
         TRACE("CompareIDs %d\n", lParam);
 
         const TItemId * id1;
         hr = GetInfoFromPidl(pidl1, &id1);
         if (FAILED(hr))
             return E_INVALIDARG;
 
         const TItemId * id2;
         hr = GetInfoFromPidl(pidl2, &id2);
         if (FAILED(hr))
             return E_INVALIDARG;
 
         hr = CompareIDs(lParam, id1, id2);
         if (hr != S_EQUAL)
             return hr;
 
         // The wollowing snipped is basically SHELL32_CompareChildren
 
         PUIDLIST_RELATIVE rest1 = ILGetNext(pidl1);
         PUIDLIST_RELATIVE rest2 = ILGetNext(pidl2);
 
         bool isEmpty1 = (rest1->mkid.cb == 0);
         bool isEmpty2 = (rest2->mkid.cb == 0);
 
         if (isEmpty1 || isEmpty2)
             return MAKE_COMPARE_HRESULT(isEmpty2 - isEmpty1);
 
         LPCITEMIDLIST first1 = ILCloneFirst(pidl1);
         if (!first1)
             return E_OUTOFMEMORY;
 
         CComPtr<IShellFolder> psfNext;
         hr = BindToObject(first1, NULL, IID_PPV_ARG(IShellFolder, &psfNext));
         if (FAILED_UNEXPECTEDLY(hr))
             return hr;
 
         return psfNext->CompareIDs(lParam, rest1, rest2);
     }

◆ CompareIDs() [2/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::CompareIDs	(	LPARAM	lParam,
		const TItemId *	first,
		const TItemId *	second
	)

protectedvirtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ CompareName()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::CompareName	(	LPARAM	lParam,
		const TItemId *	first,
		const TItemId *	second
	)

inlineprotectedvirtual

Definition at line 289 of file foldercommon.h.

     {
         bool f1 = IsFolder(first);
         bool f2 = IsFolder(second);
 
         HRESULT hr = MAKE_COMPARE_HRESULT(f2 - f1);
         if (hr != S_EQUAL)
             return hr;
 
         bool canonical = (lParam & 0xFFFF0000) == SHCIDS_CANONICALONLY;
         if (canonical)
         {
             // Shortcut: avoid comparing contents if not necessary when the results are not for display.
             hr = MAKE_COMPARE_HRESULT(second->entryNameLength - first->entryNameLength);
             if (hr != S_EQUAL)
                 return hr;
 
             int minlength = min(first->entryNameLength, second->entryNameLength);
             if (minlength > 0)
             {
                 hr = MAKE_COMPARE_HRESULT(memcmp(first->entryName, second->entryName, minlength));
                 if (hr != S_EQUAL)
                     return hr;
             }
 
             return S_EQUAL;
         }
 
         int minlength = min(first->entryNameLength, second->entryNameLength);
         if (minlength > 0)
         {
             hr = MAKE_COMPARE_HRESULT(StrCmpNW(first->entryName, second->entryName, minlength / sizeof(WCHAR)));
             if (hr != S_EQUAL)
                 return hr;
         }
 
         return MAKE_COMPARE_HRESULT(second->entryNameLength - first->entryNameLength);
     }

◆ ConvertAttributes()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual ULONG STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::ConvertAttributes	(	const TItemId *	entry,
		PULONG	inMask
	)

protectedvirtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ CreateViewObject()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::CreateViewObject	(	HWND	hwndOwner,
		REFIID	riid,
		void **	ppvOut
	)

inlinevirtual

Implements IShellFolder.

Definition at line 332 of file foldercommon.h.

     {
         if (!IsEqualIID(riid, IID_IShellView))
             return E_NOINTERFACE;
 
         _CComObject<CFolderViewCB> *pcb;
 
         HRESULT hr = _CComObject<CFolderViewCB>::CreateInstance(&pcb);
         if (FAILED(hr))
             return hr;
 
         pcb->AddRef();
 
         SFV_CREATE sfv;
         sfv.cbSize = sizeof(sfv);
         sfv.pshf = this;
         sfv.psvOuter = NULL;
         sfv.psfvcb = pcb;
 
         IShellView* view;
 
         hr = SHCreateShellFolderView(&sfv, &view);
         if (FAILED(hr))
             return hr;
 
         pcb->Initialize(view);
 
         pcb->Release();
 
         *ppvOut = view;
 
         return S_OK;
     }

◆ DefCtxMenuCallback()

template<class TSelf, typename TItemId, class TExtractIcon>

static HRESULT CALLBACK CCommonFolder< TSelf, TItemId, TExtractIcon >::DefCtxMenuCallback	(	IShellFolder *	,
		HWND	,
		IDataObject *	,
		UINT	uMsg,
		WPARAM	,
		LPARAM
	)

inlinestatic

Definition at line 696 of file foldercommon.h.

     {
         switch (uMsg)
         {
         case DFM_MERGECONTEXTMENU:
             return S_OK;
         case DFM_INVOKECOMMAND:
         case DFM_INVOKECOMMANDEX:
         case DFM_GETDEFSTATICID: // Required for Windows 7 to pick a default
             return S_FALSE;
         }
         return E_NOTIMPL;
     }

◆ EnumObjects()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::EnumObjects	(	HWND	hwndOwner,
		SHCONTF	grfFlags,
		IEnumIDList **	ppenumIDList
	)

virtual

Implements IShellFolder.

Reimplemented in CRegistryFolder, and CNtObjectFolder.

◆ EnumSearches()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::EnumSearches ( IEnumExtraSearch ** ppenum )

inlinevirtual

Implements IShellFolder2.

Definition at line 586 of file foldercommon.h.

     {
         UNIMPLEMENTED;
         return E_NOTIMPL;
     }

◆ GetAttributesOf()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetAttributesOf	(	UINT	cidl,
		PCUITEMID_CHILD_ARRAY	apidl,
		SFGAOF *	rgfInOut
	)

inlinevirtual

Implements IShellFolder.

Definition at line 369 of file foldercommon.h.

     {
         const TItemId * info;
 
         TRACE("GetAttributesOf %d\n", cidl);
 
         if (cidl == 0)
         {
             *rgfInOut &= SFGAO_FOLDER | SFGAO_HASSUBFOLDER | SFGAO_BROWSABLE;
             return S_OK;
         }
 
         for (int i = 0; i < (int)cidl; i++)
         {
             PCUITEMID_CHILD pidl = apidl[i];
 
             HRESULT hr = GetInfoFromPidl(pidl, &info);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             // Update attributes.
             *rgfInOut = ConvertAttributes(info, rgfInOut);
         }
 
         return S_OK;
     }

◆ GetClassID()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetClassID ( CLSID * lpClassId )

inlinevirtual

Implements IPersist.

Definition at line 624 of file foldercommon.h.

     {
         if (!lpClassId)
             return E_POINTER;
 
         *lpClassId = CLSID_NtObjectFolder;
         return S_OK;
     }

◆ GetCurFolder()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetCurFolder ( PIDLIST_ABSOLUTE * pidl )

inlinevirtual

Implements IPersistFolder2.

Definition at line 644 of file foldercommon.h.

     {
         if (pidl)
             *pidl = ILClone(m_shellPidl);
         if (!m_shellPidl)
             return S_FALSE;
         return S_OK;
     }

◆ GetDefaultColumn()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDefaultColumn	(	DWORD	dwReserved,
		ULONG *	pSort,
		ULONG *	pDisplay
	)

inlinevirtual

Implements IShellFolder2.

Definition at line 593 of file foldercommon.h.

     {
         if (pSort)
             *pSort = 0;
         if (pDisplay)
             *pDisplay = 0;
         return S_OK;
     }

◆ GetDefaultColumnState()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDefaultColumnState	(	UINT	iColumn,
		SHCOLSTATEF *	pcsFlags
	)

virtual

Implements IShellFolder2.

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ GetDefaultSearchGUID()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDefaultSearchGUID ( GUID * lpguid )

inlinevirtual

Implements IShellFolder2.

Definition at line 579 of file foldercommon.h.

     {
         UNIMPLEMENTED;
         return E_NOTIMPL;
     }

◆ GetDetailsEx()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDetailsEx	(	LPCITEMIDLIST	pidl,
		const SHCOLUMNID *	pscid,
		VARIANT *	pv
	)

virtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ GetDetailsOf()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDetailsOf	(	LPCITEMIDLIST	pidl,
		UINT	iColumn,
		SHELLDETAILS *	psd
	)

virtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ GetDisplayNameOf()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetDisplayNameOf	(	LPCITEMIDLIST	pidl,
		SHGDNF	uFlags,
		STRRET *	lpName
	)

inlinevirtual

Definition at line 500 of file foldercommon.h.

     {
         const TItemId * info;
 
         TRACE("GetDisplayNameOf %p\n", pidl);
 
         HRESULT hr = GetInfoFromPidl(pidl, &info);
         if (FAILED_UNEXPECTEDLY(hr))
             return hr;
 
         if (GET_SHGDN_FOR(uFlags) & SHGDN_FOREDITING)
         {
             hr = MakeStrRetFromString(info->entryName, info->entryNameLength, lpName);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
         }
 
         WCHAR path[MAX_PATH] = { 0 };
 
         if (GET_SHGDN_FOR(uFlags) & SHGDN_FORPARSING)
         {
             if (GET_SHGDN_RELATION(uFlags) != SHGDN_INFOLDER)
             {
                 hr = GetFullName(m_shellPidl, uFlags, path, _countof(path));
                 if (FAILED_UNEXPECTEDLY(hr))
                     return hr;
             }
         }
 
         PathAppendW(path, info->entryName);
 
         LPCITEMIDLIST pidlNext = ILGetNext(pidl);
         if (pidlNext && pidlNext->mkid.cb > 0)
         {
             LPITEMIDLIST pidlFirst = ILCloneFirst(pidl);
 
             CComPtr<IShellFolder> psfChild;
             hr = BindToObject(pidlFirst, NULL, IID_PPV_ARG(IShellFolder, &psfChild));
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             WCHAR temp[MAX_PATH];
             STRRET childName;
 
             hr = psfChild->GetDisplayNameOf(pidlNext, uFlags | SHGDN_INFOLDER, &childName);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             hr = StrRetToBufW(&childName, pidlNext, temp, _countof(temp));
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             PathAppendW(path, temp);
 
             ILFree(pidlFirst);
         }
 
         hr = MakeStrRetFromString(path, lpName);
         if (FAILED_UNEXPECTEDLY(hr))
             return hr;
 
         return S_OK;
     }

◆ GetInfoFromPidl()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT CCommonFolder< TSelf, TItemId, TExtractIcon >::GetInfoFromPidl	(	LPCITEMIDLIST	pcidl,
		const TItemId **	pentry
	)

protectedvirtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ GetUIObjectOf()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::GetUIObjectOf	(	HWND	hwndOwner,
		UINT	cidl,
		PCUITEMID_CHILD_ARRAY	apidl,
		REFIID	riid,
		UINT *	prgfInOut,
		void **	ppvOut
	)

inlinevirtual

Implements IShellFolder.

Definition at line 399 of file foldercommon.h.

     {
         DWORD res;
         TRACE("GetUIObjectOf\n");
 
         if (IsEqualIID(riid, IID_IContextMenu) ||
             IsEqualIID(riid, IID_IContextMenu2) ||
             IsEqualIID(riid, IID_IContextMenu3))
         {
             CComPtr<IContextMenu> pcm;
 
             HKEY keys[1];
 
             LPITEMIDLIST parent = m_shellPidl;
 
             CComPtr<IShellFolder> psfParent = this;
 
             LPCITEMIDLIST child;
 
             int nkeys = _countof(keys);
             if (cidl == 1 && IsSymLink(apidl[0]))
             {
                 const TItemId * info;
                 HRESULT hr = GetInfoFromPidl(apidl[0], &info);
                 if (FAILED(hr))
                     return hr;
 
                 LPITEMIDLIST target;
                 hr = ResolveSymLink(info, &target);
                 if (FAILED(hr))
                     return hr;
 
                 CComPtr<IShellFolder> psfTarget;
                 hr = ::SHBindToParent(target, IID_PPV_ARG(IShellFolder, &psfTarget), &child);
                 if (FAILED(hr))
                 {
                     ILFree(target);
                     return hr;
                 }
 
                 parent = ILClone(target);
                 ILRemoveLastID(parent);
                 psfParent = psfTarget;
 
                 apidl = &child;
             }
 
             if (cidl == 1 && IsFolder(apidl[0]))
             {
                 res = RegOpenKey(HKEY_CLASSES_ROOT, L"Folder", keys + 0);
                 if (!NT_SUCCESS(res))
                     return HRESULT_FROM_NT(res);
             }
             else
             {
                 nkeys = 0;
             }
 
             HRESULT hr = CDefFolderMenu_Create2(parent, hwndOwner, cidl, apidl, psfParent, DefCtxMenuCallback, nkeys, keys, &pcm);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             return pcm->QueryInterface(riid, ppvOut);
         }
 
         if (IsEqualIID(riid, IID_IExtractIconW))
         {
             return ShellObjectCreatorInit<TExtractIcon>(m_NtPath, m_shellPidl, cidl, apidl, riid, ppvOut);
         }
 
         if (IsEqualIID(riid, IID_IDataObject))
         {
             return CIDLData_CreateFromIDArray(m_shellPidl, cidl, apidl, (IDataObject**)ppvOut);
         }
 
         if (IsEqualIID(riid, IID_IQueryAssociations))
         {
             if (cidl == 1 && IsFolder(apidl[0]))
             {
                 CComPtr<IQueryAssociations> pqa;
                 HRESULT hr = AssocCreate(CLSID_QueryAssociations, IID_PPV_ARG(IQueryAssociations, &pqa));
                 if (FAILED_UNEXPECTEDLY(hr))
                     return hr;
 
                 hr = pqa->Init(ASSOCF_INIT_DEFAULTTOFOLDER, L"NTObjShEx.NTDirectory", NULL, hwndOwner);
                 if (FAILED_UNEXPECTEDLY(hr))
                     return hr;
 
                 return pqa->QueryInterface(riid, ppvOut);
             }
         }
 
         return E_NOTIMPL;
     }

◆ Initialize()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::Initialize ( PCIDLIST_ABSOLUTE pidl )

inlinevirtual

Implements IPersistFolder.

Reimplemented in CNtObjectFolder, and CRegistryFolder.

Definition at line 634 of file foldercommon.h.

     {
         m_shellPidl = ILClone(pidl);
 
         StringCbCopyW(m_NtPath, sizeof(m_NtPath), L"\\");
 
         return S_OK;
     }

◆ InternalBindToObject()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::InternalBindToObject	(	PWSTR	path,
		const TItemId *	info,
		LPITEMIDLIST	first,
		LPCITEMIDLIST	rest,
		LPITEMIDLIST	fullPidl,
		LPBC	pbcReserved,
		IShellFolder **	ppsfChild
	)

protectedvirtual

Reimplemented in CRegistryFolder, and CNtObjectFolder.

◆ IsFolder() [1/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual BOOL STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::IsFolder ( LPCITEMIDLIST pcidl )

inlineprotectedvirtual

Definition at line 664 of file foldercommon.h.

     {
         const TItemId * info;
 
         HRESULT hr = GetInfoFromPidl(pcidl, &info);
         if (FAILED(hr))
             return hr;
 
         return IsFolder(info);
     }

◆ IsFolder() [2/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual BOOL STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::IsFolder ( const TItemId * info )

protectedvirtual

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ IsSymLink() [1/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual BOOL STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::IsSymLink ( LPCITEMIDLIST pcidl )

inlineprotectedvirtual

Definition at line 677 of file foldercommon.h.

     {
         const TItemId * info;
 
         HRESULT hr = GetInfoFromPidl(pcidl, &info);
         if (FAILED(hr))
             return hr;
 
         return IsSymLink(info);
     }

◆ IsSymLink() [2/2]

template<class TSelf, typename TItemId, class TExtractIcon>

virtual BOOL STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::IsSymLink ( const TItemId * info )

inlineprotectedvirtual

Reimplemented in CNtObjectFolder.

Definition at line 688 of file foldercommon.h.

     {
         return FALSE;
     }

◆ MapColumnToSCID()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::MapColumnToSCID	(	UINT	iColumn,
		SHCOLUMNID *	pscid
	)

virtual

Implements IShellFolder2.

Reimplemented in CNtObjectFolder, and CRegistryFolder.

◆ ParseDisplayName()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::ParseDisplayName	(	HWND	hwndOwner,
		LPBC	pbcReserved,
		LPOLESTR	lpszDisplayName,
		ULONG *	pchEaten,
		LPITEMIDLIST *	ppidl,
		ULONG *	pdwAttributes
	)

inlinevirtual

Definition at line 82 of file foldercommon.h.

     {
         if (!ppidl)
             return E_POINTER;
 
         if (pchEaten)
             *pchEaten = 0;
 
         if (pdwAttributes)
             *pdwAttributes = 0;
 
         TRACE("CCommonFolder::ParseDisplayName name=%S (ntPath=%S)\n", lpszDisplayName, m_NtPath);
 
         const TItemId * info;
         IEnumIDList * it;
         HRESULT hr = EnumObjects(hwndOwner, SHCONTF_FOLDERS | SHCONTF_NONFOLDERS, &it);
         if (FAILED(hr))
             return hr;
 
         PWSTR end = StrChrW(lpszDisplayName, '\\');
         int length = end ? end - lpszDisplayName : wcslen(lpszDisplayName);
 
         while (TRUE)
         {
             hr = it->Next(1, ppidl, NULL);
 
             if (FAILED(hr))
                 return hr;
 
             if (hr != S_OK)
                 return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
 
             hr = GetInfoFromPidl(*ppidl, &info);
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             if (StrCmpNW(info->entryName, lpszDisplayName, length) == 0)
                 break;
         }
 
         // if has remaining path to parse (and the path didn't just terminate in a backslash)
         if (end && wcslen(end) > 1)
         {
             CComPtr<IShellFolder> psfChild;
             hr = BindToObject(*ppidl, pbcReserved, IID_PPV_ARG(IShellFolder, &psfChild));
             if (FAILED_UNEXPECTEDLY(hr))
                 return hr;
 
             LPITEMIDLIST child;
             hr = psfChild->ParseDisplayName(hwndOwner, pbcReserved, end + 1, pchEaten, &child, pdwAttributes);
             if (FAILED(hr))
                 return hr;
 
             LPITEMIDLIST old = *ppidl;
             *ppidl = ILCombine(old, child);
             ILFree(old);
 
             // Count the path separator
             if (pchEaten)
                 (*pchEaten) += 1;
         }
         else
         {
             if (pdwAttributes)
                 *pdwAttributes = ConvertAttributes(info, pdwAttributes);
         }
 
         if (pchEaten)
             *pchEaten += wcslen(info->entryName);
 
         return S_OK;
     }

◆ ResolveSymLink()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::ResolveSymLink	(	const TItemId *	info,
		LPITEMIDLIST *	fullPidl
	)

inlineprotectedvirtual

Reimplemented in CNtObjectFolder.

Definition at line 223 of file foldercommon.h.

     {
         return E_NOTIMPL;
     }

◆ SetNameOf()

template<class TSelf, typename TItemId, class TExtractIcon>

virtual HRESULT STDMETHODCALLTYPE CCommonFolder< TSelf, TItemId, TExtractIcon >::SetNameOf	(	HWND	hwnd,
		LPCITEMIDLIST	pidl,
		LPCOLESTR	lpszName,
		SHGDNF	uFlags,
		LPITEMIDLIST *	ppidlOut
	)

inlinevirtual

Definition at line 567 of file foldercommon.h.

     {
         UNIMPLEMENTED;
         return E_NOTIMPL;
     }

Member Data Documentation

◆ m_NtPath

template<class TSelf, typename TItemId, class TExtractIcon>

WCHAR CCommonFolder< TSelf, TItemId, TExtractIcon >::m_NtPath[MAX_PATH]

protected

Definition at line 64 of file foldercommon.h.

◆ m_shellPidl

template<class TSelf, typename TItemId, class TExtractIcon>

LPITEMIDLIST CCommonFolder< TSelf, TItemId, TExtractIcon >::m_shellPidl

protected

Definition at line 66 of file foldercommon.h.

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

dll/shellext/ntobjshex/foldercommon.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class TSelf, typename TItemId, class TExtractIcon> class CCommonFolder< TSelf, TItemId, TExtractIcon >

Constructor & Destructor Documentation

◆ CCommonFolder()

◆ ~CCommonFolder()

Member Function Documentation

◆ BindToObject()

◆ BindToStorage()

◆ CompareIDs() [1/2]

◆ CompareIDs() [2/2]

◆ CompareName()

◆ ConvertAttributes()

◆ CreateViewObject()

◆ DefCtxMenuCallback()

◆ EnumObjects()

◆ EnumSearches()

◆ GetAttributesOf()

◆ GetClassID()

◆ GetCurFolder()

◆ GetDefaultColumn()

◆ GetDefaultColumnState()

◆ GetDefaultSearchGUID()

◆ GetDetailsEx()

◆ GetDetailsOf()

◆ GetDisplayNameOf()

◆ GetInfoFromPidl()

◆ GetUIObjectOf()

◆ Initialize()

◆ InternalBindToObject()

◆ IsFolder() [1/2]

◆ IsFolder() [2/2]

◆ IsSymLink() [1/2]

◆ IsSymLink() [2/2]

◆ MapColumnToSCID()

◆ ParseDisplayName()

◆ ResolveSymLink()

◆ SetNameOf()

Member Data Documentation

◆ m_NtPath

◆ m_shellPidl

template<class TSelf, typename TItemId, class TExtractIcon>
class CCommonFolder< TSelf, TItemId, TExtractIcon >