CEnumTfContext Class Reference

#include <documentmgr.h>

Inheritance diagram for CEnumTfContext:

Collaboration diagram for CEnumTfContext:

Public Member Functions
	CEnumTfContext (_In_opt_ CDocumentMgr *mgr)
virtual	~CEnumTfContext ()
STDMETHODIMP	QueryInterface (REFIID iid, LPVOID *ppvObject) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	Next (ULONG ulCount, ITfContext **rgContext, ULONG *pcFetched) override
STDMETHODIMP	Skip (ULONG celt) override
STDMETHODIMP	Reset () override
STDMETHODIMP	Clone (IEnumTfContexts **ppenum) override
HRESULT	Clone ([out] IEnumTfContexts **ppEnum)
HRESULT	Next ([in] ULONG ulCount, [out, size_is(ulCount), length_is(*pcFetched)] ITfContext **rgContext, [out] ULONG *pcFetched)
HRESULT	Reset ()
HRESULT	Skip ([in] ULONG ulCount)
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	CreateInstance (_In_opt_ CDocumentMgr *mgr, _Out_ IEnumTfContexts **ppOut)

Protected Attributes
LONG	m_cRefs
DWORD	m_index
CDocumentMgr *	m_pDocMgr

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 62 of file documentmgr.h.

Constructor & Destructor Documentation

CEnumTfContext()

CEnumTfContext::CEnumTfContext

(

_In_opt_ CDocumentMgr *

mgr

)

Definition at line 312 of file documentmgr.cpp.

    : m_cRefs(1)
    , m_index(0)
    , m_pDocMgr(mgr)
{
    if (mgr)
        mgr->AddRef();
}

~CEnumTfContext()

CEnumTfContext::~CEnumTfContext ( )

virtual

Definition at line 321 of file documentmgr.cpp.

{
    if (m_pDocMgr)
    {
        m_pDocMgr->Release();
        m_pDocMgr = NULL;
    }
}

Member Function Documentation

Clone()

STDMETHODIMP CEnumTfContext::Clone ( IEnumTfContexts **  ppenum )

override

Implements IEnumTfContexts.

Definition at line 427 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, ppenum);
 
    if (!ppenum)
    {
        ERR("!ppenum\n");
        return E_POINTER;
    }
 
    CEnumTfContext *This = new(cicNoThrow) CEnumTfContext(m_pDocMgr);
    if (!This)
    {
        ERR("E_OUTOFMEMORY\n");
        return E_OUTOFMEMORY;
    }
 
    This->m_index = m_index;
    *ppenum = This;
    return S_OK;
}

CreateInstance()

HRESULT CEnumTfContext::CreateInstance ( _In_opt_ CDocumentMgr *  mgr, _Out_ IEnumTfContexts **  ppOut  )

static

Definition at line 330 of file documentmgr.cpp.

{
    if (!ppOut)
    {
        ERR("!ppOut\n");
        return E_POINTER;
    }
 
    CEnumTfContext *This = new(cicNoThrow) CEnumTfContext(mgr);
    if (This == NULL)
    {
        ERR("E_OUTOFMEMORY\n");
        return E_OUTOFMEMORY;
    }
 
    *ppOut = static_cast<IEnumTfContexts *>(This);
    TRACE("returning %p\n", *ppOut);
    return S_OK;
}

Referenced by EnumTfContext_Constructor().

Next()

STDMETHODIMP CEnumTfContext::Next ( ULONG  ulCount, ITfContext **  rgContext, ULONG *  pcFetched  )

override

Implements IEnumTfContexts.

Definition at line 384 of file documentmgr.cpp.

{
    TRACE("%p -> (%lu, %p, %p)\n",this, ulCount, rgContext, pcFetched);
 
    if (!rgContext)
    {
        ERR("!rgContext\n");
        return E_POINTER;
    }
 
    ULONG fetched;
    for (fetched = 0; fetched < ulCount; ++fetched, ++m_index, ++rgContext)
    {
        if (m_index >= _countof(m_pDocMgr->m_contextStack))
            break;
 
        if (!m_pDocMgr->m_contextStack[m_index])
            break;
 
        *rgContext = m_pDocMgr->m_contextStack[m_index];
        (*rgContext)->AddRef();
    }
 
    if (pcFetched)
        *pcFetched = fetched;
 
    return (fetched == ulCount) ? S_OK : S_FALSE;
}

QueryInterface()

STDMETHODIMP CEnumTfContext::QueryInterface ( REFIID  iid, LPVOID *  ppvObject  )

override

Definition at line 350 of file documentmgr.cpp.

{
    TRACE("%p -> (%s, %p)\n", this, wine_dbgstr_guid(&iid), ppvObject);
 
    *ppvObject = NULL;
 
    if (iid == IID_IUnknown || iid == IID_IEnumTfContexts)
        *ppvObject = static_cast<IEnumTfContexts *>(this);
 
    if (*ppvObject)
    {
        AddRef();
        return S_OK;
    }
 
    WARN("E_NOINTERFACE: %s\n", wine_dbgstr_guid(&iid));
    return E_NOINTERFACE;
}

Reset()

STDMETHODIMP CEnumTfContext::Reset ( )

override

Implements IEnumTfContexts.

Definition at line 420 of file documentmgr.cpp.

{
    TRACE("%p -> ()\n", this);
    m_index = 0;
    return S_OK;
}

Skip()

STDMETHODIMP CEnumTfContext::Skip ( ULONG  celt )

override

Implements IEnumTfContexts.

Definition at line 413 of file documentmgr.cpp.

{
    TRACE("%p -> (%lu)\n", this, celt);
    m_index += celt;
    return S_OK;
}

STDMETHODIMP_() [1/2]

CEnumTfContext::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

CEnumTfContext::STDMETHODIMP_ ( ULONG  )

override

Member Data Documentation

m_cRefs

LONG CEnumTfContext::m_cRefs

protected

Definition at line 83 of file documentmgr.h.

m_index

DWORD CEnumTfContext::m_index

protected

Definition at line 84 of file documentmgr.h.

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

m_pDocMgr

CDocumentMgr* CEnumTfContext::m_pDocMgr

protected

Definition at line 85 of file documentmgr.h.

Referenced by Clone(), Next(), and ~CEnumTfContext().

---

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

• base/ctf/msctf/documentmgr.h
• base/ctf/msctf/documentmgr.cpp