CSHEnumClassesOfCategories Class Reference

Inheritance diagram for CSHEnumClassesOfCategories:

Collaboration diagram for CSHEnumClassesOfCategories:

Public Member Functions
	CSHEnumClassesOfCategories ()
virtual	~CSHEnumClassesOfCategories ()
STDMETHOD()	Initialize (ULONG cImplemented, CATID *pImplemented, ULONG cRequired, CATID *pRequired)
STDMETHOD()	Clone (IEnumCLSID **ppvOut) override
STDMETHOD()	Next (ULONG cElt, CLSID *pElts, ULONG *pFetched) override
STDMETHOD()	Reset () override
STDMETHOD()	Skip (ULONG nbElts) 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 IEnumGUID
HRESULT	Next ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] GUID *rgelt, [out] ULONG *pceltFetched)
HRESULT	Skip ([in] ULONG celt)
HRESULT	Reset ()
HRESULT	Clone ([out] IEnumGUID **ppenum)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Private Attributes
CComPtr< ICatInformation >	fCatInformation
HDSA	fDsa
ULONG	fCursor

Additional Inherited Members
Public Types inherited from IEnumGUID
typedef IEnumGUID *	LPENUMGUID
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
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 212 of file CSHEnumClassesOfCategories.cpp.

Constructor & Destructor Documentation

CSHEnumClassesOfCategories()

CSHEnumClassesOfCategories::CSHEnumClassesOfCategories

(

)

Definition at line 238 of file CSHEnumClassesOfCategories.cpp.

{
    fCursor = 0;
    fDsa = DSA_Create(sizeof(GUID), 5);
}

~CSHEnumClassesOfCategories()

CSHEnumClassesOfCategories::~CSHEnumClassesOfCategories ( )

virtual

Definition at line 244 of file CSHEnumClassesOfCategories.cpp.

{
    if (fDsa)
        DSA_Destroy(fDsa);
}

Member Function Documentation

Clone()

HRESULT STDMETHODCALLTYPE CSHEnumClassesOfCategories::Clone ( IEnumCLSID **  ppvOut )

override

Definition at line 292 of file CSHEnumClassesOfCategories.cpp.

{
    return E_NOTIMPL;
}

Initialize()

HRESULT CSHEnumClassesOfCategories::Initialize	(	ULONG	cImplemented,
		CATID *	pImplemented,
		ULONG	cRequired,
		CATID *	pRequired
	)

Definition at line 250 of file CSHEnumClassesOfCategories.cpp.

{
    UINT i;
    HRESULT hr;
 
    if (!fDsa)
        return E_FAIL;
 
    // Parameter validation:
    // - We must have at least one category to manage.
    // - The array pointers must not be NULL if there is a non-zero
    //   element count specified for them.
    if (cImplemented == 0 && cRequired == 0)
        return E_INVALIDARG;
    if ((cImplemented && !pImplemented) || (cRequired && !pRequired))
        return E_INVALIDARG;
 
    // For each implemented category, create a cache and add it to our local DSA.
    for (i = 0; i < cImplemented; i++)
    {
        CComCatCachedCategory cachedCat;
        hr = cachedCat.Initialize(pImplemented[i], FALSE);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
        cachedCat.WriteCacheToDSA(fDsa);
    }
 
    // TODO: Implement caching of the required categories.
    if (cRequired > 0)
    {
        FIXME("Implement required categories class enumeration\n");
 
        // Only fail in case we didn't look at the implemented categories.
        if (cImplemented == 0)
            return E_NOTIMPL;
    }
 
    return S_OK;
}

Next()

HRESULT STDMETHODCALLTYPE CSHEnumClassesOfCategories::Next ( ULONG  cElt, CLSID *  pElts, ULONG *  pFetched  )

override

Definition at line 297 of file CSHEnumClassesOfCategories.cpp.

{
    ULONG i;
    ULONG read;
    GUID *tmp;
 
    if (!pElts)
        return E_INVALIDARG;
    read = 0;
    for (i = 0; i < cElt && (fCursor < (ULONG)DSA_GetItemCount(fDsa)); i++)
    {
        tmp = (GUID*)DSA_GetItemPtr(fDsa, fCursor + i);
        if (!tmp)
            break;
        pElts[i] = *tmp;
        read++;
    }
    fCursor += read;
    if (pFetched)
        *pFetched = read;
    return S_OK;
}

Reset()

HRESULT STDMETHODCALLTYPE CSHEnumClassesOfCategories::Reset ( )

override

Implements IEnumGUID.

Definition at line 320 of file CSHEnumClassesOfCategories.cpp.

{
    fCursor = 0;
    return S_OK;
}

Skip()

HRESULT STDMETHODCALLTYPE CSHEnumClassesOfCategories::Skip ( ULONG  nbElts )

override

Implements IEnumGUID.

Definition at line 326 of file CSHEnumClassesOfCategories.cpp.

{
    if (fCursor + nbElts >= (ULONG)DSA_GetItemCount(fDsa))
        return E_INVALIDARG;
    fCursor += nbElts;
    return S_OK;
}

Member Data Documentation

fCatInformation

CComPtr<ICatInformation> CSHEnumClassesOfCategories::fCatInformation

private

Definition at line 218 of file CSHEnumClassesOfCategories.cpp.

fCursor

ULONG CSHEnumClassesOfCategories::fCursor

private

Definition at line 220 of file CSHEnumClassesOfCategories.cpp.

Referenced by CSHEnumClassesOfCategories(), Next(), Reset(), and Skip().

fDsa

HDSA CSHEnumClassesOfCategories::fDsa

private

Definition at line 219 of file CSHEnumClassesOfCategories.cpp.

Referenced by CSHEnumClassesOfCategories(), Initialize(), Next(), Skip(), and ~CSHEnumClassesOfCategories().

---

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

• dll/win32/browseui/shellbars/CSHEnumClassesOfCategories.cpp