CCompartment Class Reference

Inheritance diagram for CCompartment:

Collaboration diagram for CCompartment:

Public Member Functions
	CCompartment (CompartmentValue *valueData)
virtual	~CCompartment ()
STDMETHODIMP	QueryInterface (REFIID iid, LPVOID *ppvObj) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	SetValue (_In_ TfClientId tid, _In_ const VARIANT *pvarValue) override
STDMETHODIMP	GetValue (_Out_ VARIANT *pvarValue) override
STDMETHODIMP	AdviseSink (_In_ REFIID riid, _In_ IUnknown *punk, _Out_ DWORD *pdwCookie) override
STDMETHODIMP	UnadviseSink (_In_ DWORD dwCookie) override
Public Member Functions inherited from ITfCompartment
HRESULT	SetValue ([in] TfClientId tid, [in] const VARIANT *pvarValue)
HRESULT	GetValue ([out] VARIANT *pvarValue)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()
Public Member Functions inherited from ITfSource
HRESULT	AdviseSink ([in] REFIID riid, [in, iid_is(riid)] IUnknown *punk, [out] DWORD *pdwCookie)
HRESULT	UnadviseSink ([in] DWORD dwCookie)

Static Public Member Functions
static HRESULT	CreateInstance (CompartmentValue *valueData, ITfCompartment **ppOut)

Protected Attributes
LONG	m_cRefs
VARIANT	m_variant
CompartmentValue *	m_valueData
struct list	m_CompartmentEventSink

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

Detailed Description

Definition at line 85 of file compartmentmgr.cpp.

Constructor & Destructor Documentation

CCompartment()

CCompartment::CCompartment

(

CompartmentValue *

valueData

)

Definition at line 410 of file compartmentmgr.cpp.

    : m_cRefs(1)
    , m_valueData(valueData)
{
    VariantInit(&m_variant);
    list_init(&m_CompartmentEventSink);
}

~CCompartment()

CCompartment::~CCompartment ( )

virtual

Definition at line 418 of file compartmentmgr.cpp.

{
    TRACE("destroying %p\n", this);
    VariantClear(&m_variant);
    free_sinks(&m_CompartmentEventSink);
}

Member Function Documentation

AdviseSink()

STDMETHODIMP CCompartment::AdviseSink ( _In_ REFIID  riid, _In_ IUnknown *  punk, _Out_ DWORD *  pdwCookie  )

override

Definition at line 520 of file compartmentmgr.cpp.

{
    TRACE("(%p) %s %p %p\n", this, debugstr_guid(&riid), punk, pdwCookie);
 
    if (cicIsNullPtr(&riid) || !punk || !pdwCookie)
        return E_INVALIDARG;
 
    if (riid == IID_ITfCompartmentEventSink)
    {
        return advise_sink(&m_CompartmentEventSink, IID_ITfCompartmentEventSink,
                           COOKIE_MAGIC_COMPARTMENTSINK, punk, pdwCookie);
    }
 
    FIXME("(%p) Unhandled Sink: %s\n", this, debugstr_guid(&riid));
    return E_NOTIMPL;
}

CreateInstance()

HRESULT CCompartment::CreateInstance ( CompartmentValue *  valueData, ITfCompartment **  ppOut  )

static

Definition at line 425 of file compartmentmgr.cpp.

{
    CCompartment *This = new(cicNoThrow) CCompartment(valueData);
    if (!This)
        return E_OUTOFMEMORY;
 
    *ppOut = static_cast<ITfCompartment *>(This);
    TRACE("returning %p\n", *ppOut);
    return S_OK;
}

Referenced by CCompartmentMgr::GetCompartment().

GetValue()

STDMETHODIMP CCompartment::GetValue ( _Out_ VARIANT *  pvarValue )

override

Definition at line 507 of file compartmentmgr.cpp.

{
    TRACE("(%p) %p\n", this, pvarValue);
 
    if (!pvarValue)
        return E_INVALIDARG;
 
    ::VariantInit(pvarValue);
    if (V_VT(&m_variant) == VT_EMPTY)
        return S_FALSE;
    return ::VariantCopy(pvarValue, &m_variant);
}

QueryInterface()

STDMETHODIMP CCompartment::QueryInterface ( REFIID  iid, LPVOID *  ppvObj  )

override

Definition at line 436 of file compartmentmgr.cpp.

{
    *ppvObj = NULL;
 
    if (iid == IID_IUnknown || iid == IID_ITfCompartment)
        *ppvObj = static_cast<ITfCompartment *>(this);
    else if (iid == IID_ITfSource)
        *ppvObj = static_cast<ITfSource *>(this);
 
    if (*ppvObj)
    {
        AddRef();
        return S_OK;
    }
 
    WARN("unsupported interface: %s\n", debugstr_guid(&iid));
    return E_NOINTERFACE;
}

SetValue()

STDMETHODIMP CCompartment::SetValue ( _In_ TfClientId  tid, _In_ const VARIANT *  pvarValue  )

override

Definition at line 468 of file compartmentmgr.cpp.

{
    ITfCompartmentEventSink *sink;
    struct list *cursor;
 
    TRACE("(%p) %i %p\n", this, tid, pvarValue);
 
    if (!pvarValue)
        return E_INVALIDARG;
 
    if (!(V_VT(pvarValue) == VT_BSTR || V_VT(pvarValue) == VT_I4 || V_VT(pvarValue) == VT_UNKNOWN))
        return E_INVALIDARG;
 
    if (!m_valueData->owner)
        m_valueData->owner = tid;
 
    ::VariantClear(&m_variant);
 
    /* Shallow copy of value and type */
    m_variant = *pvarValue;
 
    if (V_VT(pvarValue) == VT_BSTR)
    {
        V_BSTR(&m_variant) = ::SysAllocStringByteLen((char*)V_BSTR(pvarValue),
                ::SysStringByteLen(V_BSTR(pvarValue)));
    }
    else if (V_VT(pvarValue) == VT_UNKNOWN)
    {
        V_UNKNOWN(&m_variant)->AddRef();
    }
 
    SINK_FOR_EACH(cursor, &m_CompartmentEventSink, ITfCompartmentEventSink, sink)
    {
        sink->OnChange(m_valueData->guid);
    }
 
    return S_OK;
}

STDMETHODIMP_() [1/2]

CCompartment::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

CCompartment::STDMETHODIMP_ ( ULONG  )

override

UnadviseSink()

STDMETHODIMP CCompartment::UnadviseSink ( _In_ DWORD  dwCookie )

override

Definition at line 540 of file compartmentmgr.cpp.

{
    TRACE("(%p) %x\n", this, dwCookie);
 
    if (get_Cookie_magic(dwCookie) != COOKIE_MAGIC_COMPARTMENTSINK)
        return E_INVALIDARG;
 
    return unadvise_sink(dwCookie);
}

Member Data Documentation

m_CompartmentEventSink

struct list CCompartment::m_CompartmentEventSink

protected

Definition at line 115 of file compartmentmgr.cpp.

Referenced by AdviseSink(), CCompartment(), SetValue(), and ~CCompartment().

m_cRefs

LONG CCompartment::m_cRefs

protected

Definition at line 112 of file compartmentmgr.cpp.

m_valueData

CompartmentValue* CCompartment::m_valueData

protected

Definition at line 114 of file compartmentmgr.cpp.

Referenced by SetValue().

m_variant

VARIANT CCompartment::m_variant

protected

Definition at line 113 of file compartmentmgr.cpp.

Referenced by CCompartment(), GetValue(), SetValue(), and ~CCompartment().

---

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

• base/ctf/msctf/compartmentmgr.cpp