CACListISF Class Reference

#include <aclistisf.h>

Inheritance diagram for CACListISF:

Collaboration diagram for CACListISF:

Public Member Functions
	CACListISF ()
	~CACListISF ()
HRESULT	NextLocation ()
HRESULT	SetLocation (LPITEMIDLIST pidl)
HRESULT	GetDisplayName (LPCITEMIDLIST pidlChild, CComHeapPtr< WCHAR > &pszChild)
HRESULT	GetPaths (LPCITEMIDLIST pidlChild, CComHeapPtr< WCHAR > &pszRaw, CComHeapPtr< WCHAR > &pszExpanded)
STDMETHOD()	Next (ULONG celt, LPOLESTR *rgelt, ULONG *pceltFetched) override
STDMETHOD()	Skip (ULONG celt) override
STDMETHOD()	Reset () override
STDMETHOD()	Clone (IEnumString **ppenum) override
STDMETHOD()	Expand (LPCOLESTR pszExpand) override
STDMETHOD()	SetOptions (DWORD dwFlag) override
STDMETHOD()	GetOptions (DWORD *pdwFlag) override
STDMETHOD()	SetOwner (IUnknown *punkOwner) override
STDMETHOD()	GetClassID (CLSID *pClassID) override
STDMETHOD()	Initialize (PCIDLIST_ABSOLUTE pidl) override
STDMETHOD()	GetDirectory (LPWSTR pwzPath, DWORD cchSize) override
STDMETHOD()	SetDirectory (LPCWSTR pwzPath) 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 ()
Public Member Functions inherited from IEnumString
HRESULT	Next ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] LPOLESTR *rgelt, [out] ULONG *pceltFetched)
HRESULT	RemoteNext ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] LPOLESTR *rgelt, [out] ULONG *pceltFetched)
HRESULT	Skip ([in] ULONG celt)
HRESULT	Reset ()
HRESULT	Clone ([out] IEnumString **ppenum)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()
HRESULT	SetOwner ([in] IUnknown *pUnk)
HRESULT	Initialize ([in] PCIDLIST_ABSOLUTE pidl)
HRESULT	GetClassID ([out] CLSID *pClassID)

Private Types
enum	LOCATION_TYPE {   LT_DIRECTORY , LT_DESKTOP , LT_MYCOMPUTER , LT_FAVORITES ,   LT_MAX }

Private Attributes
DWORD	m_dwOptions
LOCATION_TYPE	m_iNextLocation
BOOL	m_fShowHidden
CStringW	m_szRawPath
CStringW	m_szExpanded
CComHeapPtr< ITEMIDLIST >	m_pidlLocation
CComHeapPtr< ITEMIDLIST >	m_pidlCurDir
CComPtr< IEnumIDList >	m_pEnumIDList
CComPtr< IShellFolder >	m_pShellFolder
CComPtr< IBrowserService >	m_pBrowserService

Additional Inherited Members
Public Types inherited from IEnumString
typedef IEnumString *	LPENUMSTRING
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Types inherited from IPersistFolder
typedef IPersistFolder *	LPPERSISTFOLDER
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 24 of file aclistisf.h.

Member Enumeration Documentation

LOCATION_TYPE

enum CACListISF::LOCATION_TYPE

private

Enumerator
LT_DIRECTORY
LT_DESKTOP
LT_MYCOMPUTER
LT_FAVORITES
LT_MAX

Definition at line 34 of file aclistisf.h.

    {
        LT_DIRECTORY,
        LT_DESKTOP,
        LT_MYCOMPUTER,
        LT_FAVORITES,
        LT_MAX
    };

Constructor & Destructor Documentation

CACListISF()

CACListISF::CACListISF

(

)

Definition at line 24 of file aclistisf.cpp.

    : m_dwOptions(ACLO_CURRENTDIR | ACLO_MYCOMPUTER)
    , m_iNextLocation(LT_DIRECTORY)
    , m_fShowHidden(FALSE)
{
}

~CACListISF()

CACListISF::~CACListISF

(

)

Definition at line 31 of file aclistisf.cpp.

{
}

Member Function Documentation

Clone()

STDMETHODIMP CACListISF::Clone ( IEnumString **  ppenum )

override

Implements IEnumString.

Definition at line 313 of file aclistisf.cpp.

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

Expand()

STDMETHODIMP CACListISF::Expand ( LPCOLESTR  pszExpand )

override

Definition at line 321 of file aclistisf.cpp.

{
    TRACE("(%p, %ls)\n", this, pszExpand);
 
    m_szRawPath = pszExpand;
    m_iNextLocation = LT_DIRECTORY;
 
    // skip left space
    while (*pszExpand == L' ')
        ++pszExpand;
 
    // expand environment variables (%WINDIR% etc.)
    WCHAR szExpanded[MAX_PATH], szPath1[MAX_PATH], szPath2[MAX_PATH];
    ExpandEnvironmentStringsW(pszExpand, szExpanded, _countof(szExpanded));
    pszExpand = szExpanded;
 
    // get full path
    if (szExpanded[0] && szExpanded[1] == L':' && szExpanded[2] == 0)
    {
        // 'C:' --> 'C:\'
        szExpanded[2] = L'\\';
        szExpanded[3] = 0;
    }
    else
    {
        if (PathIsRelativeW(pszExpand) &&
            SHGetPathFromIDListW(m_pidlCurDir, szPath1) &&
            PathCombineW(szPath2, szPath1, pszExpand) &&
            PathFileExistsW(szPath2))
        {
            pszExpand = szPath2;
        }
        else if (PathFileExistsW(pszExpand))
        {
            GetFullPathNameW(pszExpand, _countof(szPath1), szPath1, NULL);
            pszExpand = szPath1;
        }
    }
 
    CComHeapPtr<ITEMIDLIST> pidl;
    m_szExpanded = pszExpand;
    HRESULT hr = SHParseDisplayName(m_szExpanded, NULL, &pidl, NULL, NULL);
    if (SUCCEEDED(hr))
    {
        hr = SetLocation(pidl.Detach());
        if (FAILED_UNEXPECTEDLY(hr))
        {
            m_szRawPath = L"";
            m_szExpanded = L"";
        }
    }
    return hr;
}

GetClassID()

STDMETHODIMP CACListISF::GetClassID ( CLSID *  pClassID )

override

Implements IPersist.

Definition at line 404 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pClassID);
    if (pClassID == NULL)
        return E_POINTER;
    *pClassID = CLSID_ACListISF;
    return S_OK;
}

GetDirectory()

STDMETHODIMP CACListISF::GetDirectory ( LPWSTR  pwzPath, DWORD  cchSize  )

override

Definition at line 432 of file aclistisf.cpp.

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

GetDisplayName()

HRESULT CACListISF::GetDisplayName	(	LPCITEMIDLIST	pidlChild,
		CComHeapPtr< WCHAR > &	pszChild
	)

Definition at line 153 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pidlChild);
    pszChild.Free();
 
    STRRET StrRet;
    DWORD dwFlags = SHGDN_INFOLDER | SHGDN_FORPARSING | SHGDN_FORADDRESSBAR;
    HRESULT hr = m_pShellFolder->GetDisplayNameOf(pidlChild, dwFlags, &StrRet);
    if (FAILED(hr))
    {
        dwFlags = SHGDN_INFOLDER | SHGDN_FORPARSING;
        hr = m_pShellFolder->GetDisplayNameOf(pidlChild, dwFlags, &StrRet);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
    }
 
    hr = StrRetToStrW(&StrRet, NULL, &pszChild);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    TRACE("pszChild: '%S'\n", static_cast<LPCWSTR>(pszChild));
    return hr;
}

Referenced by GetPaths().

GetOptions()

STDMETHODIMP CACListISF::GetOptions ( DWORD *  pdwFlag )

override

Definition at line 383 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pdwFlag);
    if (pdwFlag)
    {
        *pdwFlag = m_dwOptions;
        return S_OK;
    }
    return E_INVALIDARG;
}

GetPaths()

HRESULT CACListISF::GetPaths	(	LPCITEMIDLIST	pidlChild,
		CComHeapPtr< WCHAR > &	pszRaw,
		CComHeapPtr< WCHAR > &	pszExpanded
	)

Definition at line 178 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pidlChild);
 
    CComHeapPtr<WCHAR> pszChild;
    HRESULT hr = GetDisplayName(pidlChild, pszChild);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    CStringW szRawPath, szExpanded;
    if (m_szRawPath.GetLength() && m_iNextLocation == LT_DIRECTORY)
    {
        INT cchExpand = m_szRawPath.GetLength();
        if (StrCmpNIW(pszChild, m_szRawPath, cchExpand) != 0 ||
            pszChild[0] != L'\\' || pszChild[1] != L'\\')
        {
            szRawPath = m_szRawPath;
            szExpanded = m_szExpanded;
        }
    }
    szRawPath += pszChild;
    szExpanded += pszChild;
 
    SHStrDupW(szRawPath, &pszRaw);
    SHStrDupW(szExpanded, &pszExpanded);
    TRACE("pszRaw: '%S'\n", static_cast<LPCWSTR>(pszRaw));
    TRACE("pszExpanded: '%S'\n", static_cast<LPCWSTR>(pszExpanded));
    return S_OK;
}

Referenced by Next().

Initialize()

STDMETHODIMP CACListISF::Initialize ( PCIDLIST_ABSOLUTE  pidl )

override

Implements IPersistFolder.

Definition at line 414 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pidl);
    m_pidlCurDir.Free();
    if (!pidl)
        return S_OK;
 
    LPITEMIDLIST pidlClone = ILClone(pidl);
    if (!pidlClone)
    {
        ERR("Out of memory\n");
        return E_OUTOFMEMORY;
    }
    m_pidlCurDir.Attach(pidlClone);
    return S_OK;
}

Next()

STDMETHODIMP CACListISF::Next ( ULONG  celt, LPOLESTR *  rgelt, ULONG *  pceltFetched  )

override

Implements IEnumString.

Definition at line 210 of file aclistisf.cpp.

{
    TRACE("(%p, %d, %p, %p)\n", this, celt, rgelt, pceltFetched);
 
    if (celt == 0)
        return S_OK;
    if (!rgelt)
        return S_FALSE;
 
    *rgelt = NULL;
    if (pceltFetched)
        *pceltFetched = 0;
 
    if (!m_pEnumIDList)
    {
        NextLocation();
        if (!m_pEnumIDList)
            return S_FALSE;
    }
 
    HRESULT hr;
    CComHeapPtr<ITEMIDLIST> pidlChild;
    CComHeapPtr<WCHAR> pszRawPath, pszExpanded;
 
    do
    {
        for (;;)
        {
            pidlChild.Free();
            hr = m_pEnumIDList->Next(1, &pidlChild, NULL);
            if (hr != S_OK)
                break;
 
            pszRawPath.Free();
            pszExpanded.Free();
            GetPaths(pidlChild, pszRawPath, pszExpanded);
            if (!pszRawPath || !pszExpanded)
                continue;
 
            DWORD attrs = SFGAO_FOLDER | SFGAO_FILESYSTEM;
            LPCITEMIDLIST pidlRef = pidlChild;
            hr = m_pShellFolder->GetAttributesOf(1, &pidlRef, &attrs);
            if (FAILED_UNEXPECTEDLY(hr))
                continue;
 
            if ((m_dwOptions & ACLO_FILESYSDIRS) && !(attrs & SFGAO_FOLDER))
                continue;
            if ((m_dwOptions & (ACLO_FILESYSONLY | ACLO_FILESYSDIRS)) && !(attrs & SFGAO_FILESYSTEM))
                continue;
 
            hr = S_OK;
            break;
        }
    } while (hr == S_FALSE && NextLocation() == S_OK);
 
    if (hr == S_OK)
    {
        *rgelt = pszRawPath.Detach();
        if (pceltFetched)
            *pceltFetched = 1;
    }
    else
    {
        hr = S_FALSE;
    }
 
    TRACE("*rgelt: %S\n", *rgelt);
    return hr;
}

NextLocation()

HRESULT CACListISF::NextLocation

(

)

Definition at line 35 of file aclistisf.cpp.

{
    TRACE("(%p)\n", this);
    HRESULT hr;
    switch (m_iNextLocation)
    {
        case LT_DIRECTORY:
            m_iNextLocation = LT_DESKTOP;
            if (!ILIsEmpty(m_pidlCurDir) && (m_dwOptions & ACLO_CURRENTDIR))
            {
                CComHeapPtr<ITEMIDLIST> pidl(ILClone(m_pidlCurDir));
                hr = SetLocation(pidl.Detach());
                if (SUCCEEDED(hr))
                {
                    TRACE("LT_DIRECTORY\n");
                    return hr;
                }
            }
            // FALL THROUGH
        case LT_DESKTOP:
            m_iNextLocation = LT_MYCOMPUTER;
            if (m_dwOptions & ACLO_DESKTOP)
            {
                CComHeapPtr<ITEMIDLIST> pidl;
                hr = SHGetSpecialFolderLocation(NULL, CSIDL_DESKTOP, &pidl);
                if (FAILED_UNEXPECTEDLY(hr))
                    return S_FALSE;
                hr = SetLocation(pidl.Detach());
                if (SUCCEEDED(hr))
                {
                    TRACE("LT_DESKTOP\n");
                    return hr;
                }
            }
            // FALL THROUGH
        case LT_MYCOMPUTER:
            m_iNextLocation = LT_FAVORITES;
            if (m_dwOptions & ACLO_MYCOMPUTER)
            {
                CComHeapPtr<ITEMIDLIST> pidl;
                hr = SHGetSpecialFolderLocation(NULL, CSIDL_DRIVES, &pidl);
                if (FAILED_UNEXPECTEDLY(hr))
                    return S_FALSE;
                hr = SetLocation(pidl.Detach());
                if (SUCCEEDED(hr))
                {
                    TRACE("LT_MYCOMPUTER\n");
                    return hr;
                }
            }
            // FALL THROUGH
        case LT_FAVORITES:
            m_iNextLocation = LT_MAX;
            if (m_dwOptions & ACLO_FAVORITES)
            {
                CComHeapPtr<ITEMIDLIST> pidl;
                hr = SHGetSpecialFolderLocation(NULL, CSIDL_FAVORITES, &pidl);
                if (FAILED_UNEXPECTEDLY(hr))
                    return S_FALSE;
                hr = SetLocation(pidl.Detach());
                if (SUCCEEDED(hr))
                {
                    TRACE("LT_FAVORITES\n");
                    return hr;
                }
            }
            // FALL THROUGH
        case LT_MAX:
        default:
            TRACE("LT_MAX\n");
            return S_FALSE;
    }
}

Referenced by Next().

Reset()

STDMETHODIMP CACListISF::Reset ( )

override

Implements IEnumString.

Definition at line 280 of file aclistisf.cpp.

{
    TRACE("(%p)\n", this);
 
    m_iNextLocation = LT_DIRECTORY;
    m_szRawPath = L"";
 
    SHELLSTATE ss = { 0 };
    SHGetSetSettings(&ss, SSF_SHOWALLOBJECTS, FALSE);
    m_fShowHidden = ss.fShowAllObjects;
 
    if (m_dwOptions & ACLO_CURRENTDIR)
    {
        CComHeapPtr<ITEMIDLIST> pidl;
        if (m_pBrowserService)
        {
            m_pBrowserService->GetPidl(&pidl);
            if (pidl)
                Initialize(pidl);
        }
        HRESULT hr = SetLocation(pidl.Detach());
        if (FAILED_UNEXPECTEDLY(hr))
            return S_FALSE;
    }
    return S_OK;
}

SetDirectory()

STDMETHODIMP CACListISF::SetDirectory ( LPCWSTR  pwzPath )

override

Definition at line 438 of file aclistisf.cpp.

{
    TRACE("(%p, %ls, %ld)\n", this, pwzPath);
    LPITEMIDLIST pidl = ILCreateFromPathW(pwzPath);
    if (!pidl)
    {
        ERR("Out of memory\n");
        return E_OUTOFMEMORY;
    }
    m_pidlCurDir.Attach(pidl);
    return S_OK;
}

SetLocation()

HRESULT CACListISF::SetLocation

(

LPITEMIDLIST

pidl

)

Definition at line 109 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, pidl);
 
    m_pEnumIDList.Release();
    m_pShellFolder.Release();
    m_pidlLocation.Free();
 
    if (!pidl)
        return E_FAIL;
 
    m_pidlLocation.Attach(pidl);
 
    CComPtr<IShellFolder> pFolder;
    HRESULT hr = SHGetDesktopFolder(&pFolder);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    if (!ILIsEmpty(pidl))
    {
        hr = pFolder->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder, &m_pShellFolder));
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
    }
    else
    {
        m_pShellFolder.Attach(pFolder.Detach());
    }
 
    SHCONTF Flags = SHCONTF_FOLDERS | SHCONTF_INIT_ON_FIRST_NEXT;
    if (m_fShowHidden)
        Flags |= SHCONTF_INCLUDEHIDDEN;
    if (!(m_dwOptions & ACLO_FILESYSDIRS))
        Flags |= SHCONTF_NONFOLDERS;
 
    hr = m_pShellFolder->EnumObjects(NULL, Flags, &m_pEnumIDList);
    if (hr != S_OK)
    {
        ERR("EnumObjects failed: 0x%lX\n", hr);
        hr = E_FAIL;
    }
    return hr;
}

Referenced by Expand(), NextLocation(), and Reset().

SetOptions()

STDMETHODIMP CACListISF::SetOptions ( DWORD  dwFlag )

override

Definition at line 376 of file aclistisf.cpp.

{
    TRACE("(%p, %lu)\n", this, dwFlag);
    m_dwOptions = dwFlag;
    return S_OK;
}

SetOwner()

STDMETHODIMP CACListISF::SetOwner ( IUnknown *  punkOwner )

override

Implements IShellService.

Definition at line 395 of file aclistisf.cpp.

{
    TRACE("(%p, %p)\n", this, punkOwner);
    m_pBrowserService.Release();
    punkOwner->QueryInterface(IID_PPV_ARG(IBrowserService, &m_pBrowserService));
    return S_OK;
}

Skip()

STDMETHODIMP CACListISF::Skip ( ULONG  celt )

override

Implements IEnumString.

Definition at line 307 of file aclistisf.cpp.

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

Member Data Documentation

m_dwOptions

DWORD CACListISF::m_dwOptions

private

Definition at line 43 of file aclistisf.h.

Referenced by GetOptions(), Next(), NextLocation(), Reset(), SetLocation(), and SetOptions().

m_fShowHidden

BOOL CACListISF::m_fShowHidden

private

Definition at line 45 of file aclistisf.h.

Referenced by Reset(), and SetLocation().

m_iNextLocation

LOCATION_TYPE CACListISF::m_iNextLocation

private

Definition at line 44 of file aclistisf.h.

Referenced by Expand(), GetPaths(), NextLocation(), and Reset().

m_pBrowserService

CComPtr<IBrowserService> CACListISF::m_pBrowserService

private

Definition at line 52 of file aclistisf.h.

Referenced by Reset(), and SetOwner().

m_pEnumIDList

CComPtr<IEnumIDList> CACListISF::m_pEnumIDList

private

Definition at line 50 of file aclistisf.h.

Referenced by Next(), and SetLocation().

m_pidlCurDir

CComHeapPtr<ITEMIDLIST> CACListISF::m_pidlCurDir

private

Definition at line 49 of file aclistisf.h.

Referenced by Expand(), Initialize(), NextLocation(), and SetDirectory().

m_pidlLocation

CComHeapPtr<ITEMIDLIST> CACListISF::m_pidlLocation

private

Definition at line 48 of file aclistisf.h.

Referenced by SetLocation().

m_pShellFolder

CComPtr<IShellFolder> CACListISF::m_pShellFolder

private

Definition at line 51 of file aclistisf.h.

Referenced by GetDisplayName(), Next(), and SetLocation().

m_szExpanded

CStringW CACListISF::m_szExpanded

private

Definition at line 47 of file aclistisf.h.

Referenced by Expand(), and GetPaths().

m_szRawPath

CStringW CACListISF::m_szRawPath

private

Definition at line 46 of file aclistisf.h.

Referenced by Expand(), GetPaths(), and Reset().

---

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

• dll/win32/browseui/aclistisf.h
• dll/win32/browseui/aclistisf.cpp