CFolder Class Reference

#include <CFolder.h>

Inheritance diagram for CFolder:

Collaboration diagram for CFolder:

Public Types
enum	{ INFOTIPCOLUMN = -1 }

Public Member Functions
	CFolder ()
	~CFolder ()
HRESULT	Initialize (LPCITEMIDLIST idlist, IDispatch *pDispatch)
LPCITEMIDLIST	GetAbsoluteIDList ()
HWND	GetHwnd ()
IUnknown *	GetSite ()
STDMETHOD()	get_Title (BSTR *pbs) override
STDMETHOD()	get_Application (IDispatch **ppid) override
STDMETHOD()	get_Parent (IDispatch **ppid) override
STDMETHOD()	get_ParentFolder (Folder **ppsf) override
STDMETHOD()	Items (FolderItems **ppid) override
STDMETHOD()	ParseName (BSTR bName, FolderItem **ppid) override
STDMETHOD()	NewFolder (BSTR bName, VARIANT vOptions) override
STDMETHOD()	MoveHere (VARIANT vItem, VARIANT vOptions) override
STDMETHOD()	CopyHere (VARIANT vItem, VARIANT vOptions) override
STDMETHOD()	GetDetailsOf (VARIANT vItem, int iColumn, BSTR *pbs) override
STDMETHOD()	get_Self (FolderItem **ppfi) override
STDMETHOD()	get_OfflineStatus (LONG *pul) override
STDMETHOD()	Synchronize () override
STDMETHOD()	get_HaveToShowWebViewBarricade (VARIANT_BOOL *pbHaveToShowWebViewBarricade) override
STDMETHOD()	DismissedWebViewBarricade () 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	GetUIObjectFromVariant (VARIANT &vItem, REFIID riid, void **ppv)
static HRESULT	CreateInstance (LPCITEMIDLIST pidl, IDispatch *pDispatch, REFIID riid, void **ppv)
static HRESULT	CreateInstance (LPCITEMIDLIST pidl, Folder &Instance, REFIID riid, void **ppv)
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
HRESULT	GetShellFolder (CComPtr< IShellFolder > &psfCurrent)
HRESULT	CopyMoveOperation (VARIANT &vItem, VARIANT vOptions, BOOL bCopy)

Private Attributes
CComHeapPtr< ITEMIDLIST >	m_idlist
CComPtr< IDispatch >	m_Application

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

Detailed Description

Definition at line 12 of file CFolder.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
INFOTIPCOLUMN

Definition at line 28 of file CFolder.h.

{ INFOTIPCOLUMN = -1 }; // learn.microsoft.com/en-us/windows/win32/shell/folder-getdetailsof

Constructor & Destructor Documentation

CFolder()

CFolder::CFolder

(

)

Definition at line 36 of file CFolder.cpp.

{
}

~CFolder()

CFolder::~CFolder

(

)

Definition at line 40 of file CFolder.cpp.

{
}

Member Function Documentation

CopyHere()

HRESULT STDMETHODCALLTYPE CFolder::CopyHere ( VARIANT  vItem, VARIANT  vOptions  )

override

Definition at line 254 of file CFolder.cpp.

{
    TRACE("(%p, %s, %s)\n", this, wine_dbgstr_variant(&vItem), wine_dbgstr_variant(&vOptions));
    return CopyMoveOperation(vItem, vOptions, TRUE);
}

CopyMoveOperation()

HRESULT CFolder::CopyMoveOperation ( VARIANT &  vItem, VARIANT  vOptions, BOOL  bCopy  )

private

Definition at line 215 of file CFolder.cpp.

{
    CComPtr<IShellFolder> psfCurrent;
    HRESULT hr = GetShellFolder(psfCurrent);
    if (FAILED(hr))
        return hr;
 
    CComPtr<IDropTarget> pDT;
    if (FAILED_UNEXPECTEDLY(hr = psfCurrent->CreateViewObject(GetHwnd(), IID_PPV_ARG(IDropTarget, &pDT))))
        return hr;
 
    CComPtr<IDataObject> pDO;
    hr = GetUIObjectFromVariant(vItem, IID_PPV_ARG(IDataObject, &pDO));
    if (hr == HRESULT_FROM_WIN32(ERROR_NO_DATA))
        return S_FALSE;
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    if (SUCCEEDED(VariantChangeType(&vOptions, &vOptions, 0, VT_I4)))
    {
        UINT flags = V_I4(&vOptions) & ~(FOF_MULTIDESTFILES | FOF_WANTMAPPINGHANDLE);
        if (flags)
        {
            extern UINT g_cf_FileOpFlags;
            if (!g_cf_FileOpFlags)
                g_cf_FileOpFlags = RegisterClipboardFormatW(L"FileOpFlags");
            DataObj_SetDWORD(pDO, g_cf_FileOpFlags, flags);
        }
    }
    hr = SH32_SimulateDropWithSite(pDT, pDO, MK_LBUTTON | (bCopy ? MK_CONTROL : MK_SHIFT), NULL, NULL, GetSite());
    return SUCCEEDED(hr) ? S_OK : S_FALSE;
}

Referenced by CopyHere(), and MoveHere().

CreateInstance() [1/2]

static HRESULT CFolder::CreateInstance ( LPCITEMIDLIST  pidl, Folder &  Instance, REFIID  riid, void **  ppv  )

inlinestatic

Definition at line 59 of file CFolder.h.

    {
        CComPtr<IDispatch> pDisp;
        HRESULT hr = Instance.get_Application(&pDisp);
        return SUCCEEDED(hr) ? CreateInstance(pidl, pDisp, riid, ppv) : hr;
    }

CreateInstance() [2/2]

static HRESULT CFolder::CreateInstance ( LPCITEMIDLIST  pidl, IDispatch *  pDispatch, REFIID  riid, void **  ppv  )

inlinestatic

Definition at line 55 of file CFolder.h.

    {
        return ShellObjectCreatorInit<CFolder>(pidl, pDispatch, riid, ppv);
    }

Referenced by CShellDispatch::BrowseForFolder(), CFolderItem::get_GetFolder(), get_ParentFolder(), CShellDispatch::NameSpace(), and ParseName().

DismissedWebViewBarricade()

HRESULT STDMETHODCALLTYPE CFolder::DismissedWebViewBarricade ( )

override

Definition at line 321 of file CFolder.cpp.

{
    TRACE("(%p)\n", this);
    return E_NOTIMPL;
}

get_Application()

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

override

Definition at line 69 of file CFolder.cpp.

{
    TRACE("(%p, %p)\n", this, ppid);
 
    if (!ppid)
        return E_INVALIDARG;
 
    *ppid = m_Application;
    (*ppid)->AddRef();
 
    return S_OK;
}

get_HaveToShowWebViewBarricade()

HRESULT STDMETHODCALLTYPE CFolder::get_HaveToShowWebViewBarricade ( VARIANT_BOOL *  pbHaveToShowWebViewBarricade )

override

Definition at line 315 of file CFolder.cpp.

{
    TRACE("(%p, %p)\n", this, pbHaveToShowWebViewBarricade);
    return E_NOTIMPL;
}

get_OfflineStatus()

HRESULT STDMETHODCALLTYPE CFolder::get_OfflineStatus ( LONG *  pul )

override

Definition at line 303 of file CFolder.cpp.

{
    TRACE("(%p, %p)\n", this, pul);
    return E_NOTIMPL;
}

get_Parent()

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

override

Definition at line 82 of file CFolder.cpp.

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

get_ParentFolder()

HRESULT STDMETHODCALLTYPE CFolder::get_ParentFolder ( Folder **  ppsf )

override

Definition at line 92 of file CFolder.cpp.

{
    TRACE("(%p, %p)\n", this, ppsf);
 
    *ppsf = NULL;
    LPCITEMIDLIST pidlAbsSelf = GetAbsoluteIDList();
    if (ILIsEmpty(pidlAbsSelf))
        return S_FALSE;
 
    CComHeapPtr<ITEMIDLIST> pidlParent;
    if (FAILED(SHILCloneParent(pidlAbsSelf, &pidlParent)))
        return E_OUTOFMEMORY;
    return CFolder::CreateInstance(pidlParent, m_Application, IID_PPV_ARG(Folder, ppsf));
}

get_Self()

HRESULT STDMETHODCALLTYPE CFolder::get_Self ( FolderItem **  ppfi )

override

Definition at line 294 of file CFolder.cpp.

{
    TRACE("(%p, %p)\n", this, ppfi);
    if (!ppfi)
        return E_POINTER;
 
    return ShellObjectCreatorInit<CFolderItem>(this, GetAbsoluteIDList(), IID_PPV_ARG(FolderItem, ppfi));
}

get_Title()

HRESULT STDMETHODCALLTYPE CFolder::get_Title ( BSTR *  pbs )

override

Definition at line 58 of file CFolder.cpp.

{
    if (!pbs)
        return E_POINTER;
 
    WCHAR path[MAX_PATH];
    HRESULT hr = ILGetDisplayNameExW(NULL, m_idlist, path, ILGDN_INFOLDER) ? S_OK : E_FAIL;
    *pbs = SysAllocString(SUCCEEDED(hr) ? path : L"");
    return S_OK;
}

GetAbsoluteIDList()

LPCITEMIDLIST CFolder::GetAbsoluteIDList ( )

inline

Definition at line 31 of file CFolder.h.

{ return m_idlist; }

Referenced by get_ParentFolder(), get_Self(), GetShellFolder(), Items(), NewFolder(), and ParseName().

GetDetailsOf()

HRESULT STDMETHODCALLTYPE CFolder::GetDetailsOf ( VARIANT  vItem, int  iColumn, BSTR *  pbs  )

override

Definition at line 260 of file CFolder.cpp.

{
    TRACE("(%p, %s, %i, %p)\n", this, wine_dbgstr_variant(&vItem), iColumn, pbs);
 
    CComPtr<IShellFolder> psf;
    HRESULT hr = GetShellFolder(psf);
    if (FAILED(hr))
        return hr;
 
    CComHeapPtr<ITEMIDLIST> pidlItem(CFolderItem::CloneLeafPidl(&vItem));
    if (pidlItem && iColumn == INFOTIPCOLUMN)
    {
        PWSTR pszTip = NULL;
        if (SUCCEEDED(hr = SHELL_QueryInfoTipAlloc(psf, QITIPF_DEFAULT, pidlItem, &pszTip)))
        {
            hr = SHELL_SysAllocString(pszTip, pbs);
            SHFree(pszTip);
            return hr;
        }
    }
    else
    {
        VARIANT v;
        if (pbs && SUCCEEDED(SHELL_GetDetailsOfAsStringVariant(psf, pidlItem, iColumn, &v)))
        {
            *pbs = V_BSTR(&v);
            return S_OK;
        }
    }
    return SHELL_SysAllocString(L"", pbs);
}

GetHwnd()

HWND CFolder::GetHwnd ( )

inline

Definition at line 32 of file CFolder.h.

{ return NULL; }

Referenced by CopyMoveOperation().

GetShellFolder()

HRESULT CFolder::GetShellFolder ( CComPtr< IShellFolder > &  psfCurrent )

private

Definition at line 50 of file CFolder.cpp.

{
    HRESULT hr = SHBindToObject(NULL, GetAbsoluteIDList(), NULL, IID_PPV_ARG(IShellFolder, &psfCurrent));
    FAILED_UNEXPECTEDLY(hr);
    return hr;
}

Referenced by CopyMoveOperation(), GetDetailsOf(), and ParseName().

GetSite()

IUnknown * CFolder::GetSite ( )

inline

Definition at line 33 of file CFolder.h.

{ return NULL; }

Referenced by CopyMoveOperation().

GetUIObjectFromVariant()

HRESULT CFolder::GetUIObjectFromVariant ( VARIANT &  vItem, REFIID  riid, void **  ppv  )

static

Definition at line 179 of file CFolder.cpp.

{
    HWND hWnd = NULL;
    CComHeapPtr<ITEMIDLIST> pidlOneItem;
    if (SUCCEEDED(VariantToIdlist(&vItem, &pidlOneItem)))
        return SHELL_GetUIObjectOfAbsoluteItem(hWnd, pidlOneItem, riid, ppv);
 
    HRESULT hr = E_NOTIMPL;
    CComPtr<FolderItems> pItems;
    if (SUCCEEDED(VariantQueryInterface(&vItem, IID_PPV_ARG(FolderItems, &pItems))))
    {
        long count;
        if (FAILED(hr = pItems->get_Count(&count)))
            return hr;
        if (count <= 0)
            return HRESULT_FROM_WIN32(ERROR_NO_DATA);
 
        LPITEMIDLIST *ppidls = (LPITEMIDLIST*)SHAlloc(sizeof(*ppidls) * count);
        if (!ppidls)
            return E_OUTOFMEMORY;
        CComPtr<IShellFolder> pFolder;
        for (UINT i = 0; i < (UINT)count; ++i)
        {
            if (SUCCEEDED(hr = GetFolderItem(pItems, i, i == 0 ? &pFolder : NULL, &ppidls[i])))
                continue;
            ppidls[i] = NULL;
            count = i; // Don't free undefined items. Stop the loop.
        }
 
        if (SUCCEEDED(hr))
            hr = pFolder->GetUIObjectOf(hWnd, count, const_cast<LPCITEMIDLIST*>(ppidls), riid, NULL, ppv);
        _ILFreeaPidl(ppidls, count);
    }
    return hr;
}

Referenced by CopyMoveOperation(), and GetUIObjectOfFolderItems().

Initialize()

HRESULT CFolder::Initialize	(	LPCITEMIDLIST	idlist,
		IDispatch *	pDispatch
	)

Definition at line 44 of file CFolder.cpp.

{
    m_Application = pDispatch;
    return SHILClone(idlist, &m_idlist);
}

Items()

HRESULT STDMETHODCALLTYPE CFolder::Items ( FolderItems **  ppid )

override

Definition at line 107 of file CFolder.cpp.

{
    /* FolderItems_Constructor */
    return ShellObjectCreatorInit<CFolderItems>(GetAbsoluteIDList(), this, IID_PPV_ARG(FolderItems, ppid));
}

MoveHere()

HRESULT STDMETHODCALLTYPE CFolder::MoveHere ( VARIANT  vItem, VARIANT  vOptions  )

override

Definition at line 248 of file CFolder.cpp.

{
    TRACE("(%p, %s, %s)\n", this, wine_dbgstr_variant(&vItem), wine_dbgstr_variant(&vOptions));
    return CopyMoveOperation(vItem, vOptions, FALSE);
}

NewFolder()

HRESULT STDMETHODCALLTYPE CFolder::NewFolder ( BSTR  bName, VARIANT  vOptions  )

override

Definition at line 145 of file CFolder.cpp.

{
    TRACE("(%p, %s, %s)\n", this, wine_dbgstr_w(bName), wine_dbgstr_variant(&vOptions));
 
    // Note: MSDN says vOptions "is not currently used"
    CComPtr<IStorage> pStg, pStgNew;
    HRESULT hr = SHBindToObject(NULL, GetAbsoluteIDList(), NULL, IID_PPV_ARG(IStorage, &pStg));
    if (FAILED(hr))
        goto tryfs;//return hr;
    hr = pStg->CreateStorage(bName, STGM_FAILIFTHERE, 0, 0, &pStgNew);
    return (hr == STG_E_FILEALREADYEXISTS) ? S_OK : hr;
 
tryfs: // HACKFIX: Our CFSFolder does not yet support IStorage, try it directly
    LPCITEMIDLIST pidlAbsSelf = GetAbsoluteIDList();
    if (SHGetAttributes(NULL, pidlAbsSelf, SFGAO_FILESYSTEM) == SFGAO_FILESYSTEM)
    {
        CComHeapPtr<WCHAR> pszDirPath;
        if (SUCCEEDED(SHELL_DisplayNameOf(NULL, pidlAbsSelf, SHGDN_FORPARSING, &pszDirPath)))
        {
            DWORD cch = wcslen(pszDirPath) + 1 + wcslen(bName) + 1, attr;
            if (PWSTR pszPath = (PWSTR)SHAlloc(cch * sizeof(WCHAR)))
            {
                StringCchPrintfW(pszPath, cch, L"%s\\%s", &pszDirPath[0], bName);
                if (PathFileExistsAndAttributesW(pszPath, &attr))
                    hr = (attr & FILE_ATTRIBUTE_DIRECTORY) ? S_OK : S_FALSE;
                else
                    hr = Win32CreateDirectoryW(pszPath, NULL) ? S_OK : E_FAIL;
                SHFree(pszPath);
            }
        }
    }
    return hr;
}

ParseName()

HRESULT STDMETHODCALLTYPE CFolder::ParseName ( BSTR  bName, FolderItem **  ppid  )

override

Definition at line 113 of file CFolder.cpp.

{
    TRACE("(%p, %s, %p)\n", this, wine_dbgstr_w(bName), ppid);
    if (!ppid)
        return E_POINTER;
    *ppid = NULL;
 
    CComPtr<IShellFolder> psfCurrent;
    HRESULT hr = GetShellFolder(psfCurrent);
    if (FAILED(hr))
        return hr;
 
    CComHeapPtr<ITEMIDLIST_RELATIVE> relativePidl;
    hr = psfCurrent->ParseDisplayName(NULL, NULL, bName, NULL, &relativePidl, NULL);
    if (!SUCCEEDED(hr))
        return S_FALSE;
    CComHeapPtr<ITEMIDLIST> combined;
    combined.Attach(ILCombine(GetAbsoluteIDList(), relativePidl));
    if (!combined)
        return E_OUTOFMEMORY;
 
    CComHeapPtr<ITEMIDLIST> parentPidl;
    if (FAILED(hr = SHILCloneParent((LPCITEMIDLIST)combined, &parentPidl)))
        return hr;
    CComPtr<Folder> pParent; // The parent Folder of the thing we just parsed
    hr = CFolder::CreateInstance(parentPidl, m_Application, IID_PPV_ARG(Folder, &pParent));
    if (FAILED(hr))
        return hr;
 
    return ShellObjectCreatorInit<CFolderItem>(pParent, static_cast<LPITEMIDLIST>(combined), IID_PPV_ARG(FolderItem, ppid));
}

Synchronize()

HRESULT STDMETHODCALLTYPE CFolder::Synchronize ( )

override

Definition at line 309 of file CFolder.cpp.

{
    TRACE("(%p)\n", this);
    return E_NOTIMPL;
}

Member Data Documentation

m_Application

CComPtr<IDispatch> CFolder::m_Application

private

Definition at line 22 of file CFolder.h.

Referenced by get_Application(), get_ParentFolder(), Initialize(), and ParseName().

m_idlist

CComHeapPtr<ITEMIDLIST> CFolder::m_idlist

private

Definition at line 21 of file CFolder.h.

Referenced by get_Title(), GetAbsoluteIDList(), and Initialize().

---

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

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