CSnapin Class Reference

#include <CSnapin.h>

Collaboration diagram for CSnapin:

Public Member Functions
	CSnapin (CSnapinCacheEntry *CacheEntry, UINT NodeId, PWSTR displayName=NULL)
	~CSnapin ()
const CAtlString &	Name () const
const CAtlString &	Provider () const
const CAtlString &	Description () const
const CAtlString &	Version () const
const CAtlString &	DisplayName () const
void	SetDisplayName (LPWSTR pszName)
UINT	GetNodeId ()
CSnapinCacheEntry *	CacheEntry ()
void	OnAdd (IConsole *console)
void	OnAccept (IConsole *console)
VOID	SaveNode (MscFile *mscFile, IXMLDOMElement *pParentNode)

Static Public Member Functions
static HRESULT	ParseSnapin (CMainWnd *pMainWnd, MscFile *mscFile, IXMLDOMElement *pSnapinNode, CSnapin **ppSnapin)

Public Attributes
CAtlList< CSnapin * >	m_SubNodes

Private Member Functions
void	RemoveAllSubnodes ()

Private Attributes
UINT	m_NodeId
CSnapinCacheEntry *	m_CacheEntry
CAtlString	m_DisplayName

Detailed Description

Definition at line 23 of file CSnapin.h.

Constructor & Destructor Documentation

CSnapin()

CSnapin::CSnapin	(	CSnapinCacheEntry *	CacheEntry,
		UINT	NodeId,
		PWSTR	displayName = NULL
	)

Definition at line 22 of file CSnapin.cpp.

    :m_CacheEntry(CacheEntry)
{
    m_NodeId = NodeId;
    if (displayName)
        m_DisplayName = displayName;
    else
        m_DisplayName = m_CacheEntry->Name();
}

~CSnapin()

CSnapin::~CSnapin

(

)

Definition at line 32 of file CSnapin.cpp.

{
    RemoveAllSubnodes();
}

Member Function Documentation

CacheEntry()

CSnapinCacheEntry * CSnapin::CacheEntry

(

)

Definition at line 54 of file CSnapin.cpp.

{
    return m_CacheEntry;
}

Referenced by CAboutSnapinDialog::OnInitDialog(), and SaveNode().

Description()

const CAtlString & CSnapin::Description

(

)

const

Definition at line 39 of file CSnapin.cpp.

{ return m_CacheEntry->Description(); }

DisplayName()

const CAtlString & CSnapin::DisplayName

(

)

const

Definition at line 41 of file CSnapin.cpp.

{ return m_DisplayName; }

Referenced by CConsoleWnd::OnActionNewWindow(), CConsoleWnd::OnNotify(), and CConsoleWnd::ParseView().

GetNodeId()

UINT CSnapin::GetNodeId

(

)

Definition at line 49 of file CSnapin.cpp.

{
    return m_NodeId;
}

Referenced by CConsoleWnd::SaveView().

Name()

const CAtlString & CSnapin::Name

(

)

const

Definition at line 37 of file CSnapin.cpp.

{ return m_CacheEntry->Name(); }

Referenced by CAboutSnapinDialog::OnInitDialog(), and CMainWnd::UpdateAboutSnapinMenu().

OnAccept()

void CSnapin::OnAccept

(

IConsole *

console

)

Definition at line 88 of file CSnapin.cpp.

{
#if 0
    CComPtr<IComponentData> spComponentData;
    HRESULT hr = CoCreateInstance(m_Guid, NULL, CLSCTX_INPROC, IID_PPV_ARG(IComponentData, &spComponentData));
 
    if (SUCCEEDED(hr))
    {
        hr = spComponentData->Initialize(console);
        // CComponentData::CreatePropertyPages(
        if (SUCCEEDED(hr))
        {
            SCOPEDATAITEM item = { 0 };
            item.mask = SDI_STR | SDI_IMAGE | SDI_OPENIMAGE;
 
            hr = spComponentData->GetDisplayInfo(&item);
 
            printf("%S\n", item.displayname);
 
 
            CComPtr<IDataObject> spDataObject;
 
            hr = spComponentData->QueryDataObject(NULL, CCT_SCOPE, &spDataObject);
 
            if (SUCCEEDED(hr))
            {
                //spDataObject->
            }
        }
    }
#endif
}

OnAdd()

void CSnapin::OnAdd

(

IConsole *

console

)

Definition at line 74 of file CSnapin.cpp.

{
#if 0
    CComPtr<IComponentData> spComponentData;
    HRESULT hr = CoCreateInstance(m_Guid, NULL, CLSCTX_INPROC, IID_PPV_ARG(IComponentData, &spComponentData));
 
    if (SUCCEEDED(hr))
    {
        //CComPtr<IExtendPropertySheet> spPropertySheet;
    }
#endif
}

ParseSnapin()

HRESULT CSnapin::ParseSnapin ( CMainWnd *  pMainWnd, MscFile *  mscFile, IXMLDOMElement *  pSnapinNode, CSnapin **  ppSnapin  )

static

Definition at line 188 of file CSnapin.cpp.

{
    VARIANT SnapinID, SnapinCLSID, SnapinDisplayName;
    IXMLDOMElement *pStringElement = NULL;
    IXMLDOMElement *pNodesElement = NULL;
    IXMLDOMNodeList *pChildList = NULL;
    PWSTR pwstr;
    CSnapinCacheEntry *pCacheEntry = NULL;
    CSnapin *pSnapin = NULL;
    UINT uSnapinId;
    HRESULT hr = S_OK;
 
    VariantInit(&SnapinID);
    VariantInit(&SnapinCLSID);
    VariantInit(&SnapinDisplayName);
 
    /* Read the ID attribute */
    hr = mscFile->GetAttribute(pSnapinNode, (LPWSTR)L"ID", &SnapinID);
    if (hr != S_OK)
        goto done;
 
    /* Read the CLSID attribute */
    hr = mscFile->GetAttribute(pSnapinNode, (LPWSTR)L"CLSID", &SnapinCLSID);
    if (hr != S_OK)
        goto done;
 
    /* FIXME: Read the ImageIdx attribute */
    /* FIXME: Read the Preload attribute */
 
    /* Open the String Element */
    hr = mscFile->GetElement(pSnapinNode, (LPWSTR)L"String", &pStringElement);
    if (hr != S_OK)
        goto done;
 
    /* Read the Name attribute */
    hr = mscFile->GetAttribute(pStringElement, (LPWSTR)L"Name", &SnapinDisplayName);
    if (hr != S_OK)
        goto done;
 
    /* FIXME: Use a string cache and the ID attribute instead of Name later */
 
    /* Create the Snap-in */
    pCacheEntry = pMainWnd->GetSnapinCacheEntryByGuid(V_BSTR(&SnapinCLSID));
    if (pCacheEntry == NULL)
    {
        hr = E_FAIL;
        goto done;
    }
 
    uSnapinId = (UINT)wcstoul(V_BSTR(&SnapinID), &pwstr, 10);
    pMainWnd->UpdateNextNodeId(uSnapinId);
 
    pSnapin = new CSnapin(pCacheEntry,
                          uSnapinId,
                          V_BSTR(&SnapinDisplayName));
    if (pSnapin == NULL)
    {
        hr = E_FAIL;
        goto done;
    }
 
    /* Add the Snap-in to the temporary node map */
    pMainWnd->m_TempNodeMap->Add(uSnapinId, pSnapin);
 
    /* FIXME: Read the Bitmaps element */
    /* FIXME: Read the ComponentDatas element */
    /* FIXME: Read the Component element */
 
    /* Get the Nodes element */
    hr = mscFile->GetElement(pSnapinNode, (LPWSTR)L"Nodes", &pNodesElement);
    if (hr != S_OK)
        goto done;
 
    hr = pNodesElement->get_childNodes(&pChildList);
    if (FAILED(hr))
        goto done;
 
done:
    if (pStringElement)
        pStringElement->Release();
 
    VariantInit(&SnapinDisplayName);
    VariantInit(&SnapinCLSID);
    VariantInit(&SnapinID);
 
    /* Parse Nodes Element and create Sub-Snapins */
    if (pChildList)
    {
        IXMLDOMNode *nextItem;
        DOMNodeType NodeType;
        BSTR NodeName = NULL;
 
        for (;;)
        {
            hr = pChildList->nextNode(&nextItem);
            if (hr == S_FALSE)
            {
                hr = S_OK;
                break;
            }
 
            hr = nextItem->get_nodeType(&NodeType);
            if (hr == S_OK)
            {
                if (NodeType == NODE_ELEMENT)
                {
                    NodeName = NULL;
                    hr = nextItem->get_baseName(&NodeName);
                    if (hr == S_OK)
                    {
                        if (_wcsicmp(NodeName, L"Node") == 0)
                        {
                            CSnapin *pSubSnapin;
                            hr = ParseSnapin(pMainWnd, mscFile, (IXMLDOMElement *)nextItem, &pSubSnapin);
                            if (hr == S_OK)
                            {
                                pSnapin->m_SubNodes.AddTail(pSubSnapin);
                            }
                        }
                        SysFreeString(NodeName);
                        NodeName = NULL;
                    }
                }
            }
 
            nextItem->Release();
        }
 
        pChildList->Release();
 
        if (NodeName)
            SysFreeString(NodeName);
    }
 
    if (pNodesElement)
        pNodesElement->Release();
 
    *ppSnapin = pSnapin;
 
    return hr;
}

Referenced by CMainWnd::ParseScopeTree(), and ParseSnapin().

Provider()

const CAtlString & CSnapin::Provider

(

)

const

Definition at line 38 of file CSnapin.cpp.

{ return m_CacheEntry->Provider(); }

RemoveAllSubnodes()

void CSnapin::RemoveAllSubnodes ( )

private

Definition at line 60 of file CSnapin.cpp.

{
    CSnapin *SubNode;
    POSITION pos = m_SubNodes.GetHeadPosition();
    while (pos != NULL)
    {
        SubNode = (CSnapin*)m_SubNodes.GetNext(pos);
        if (SubNode)
            delete SubNode;
    }
    m_SubNodes.RemoveAll();
}

Referenced by ~CSnapin().

SaveNode()

VOID CSnapin::SaveNode	(	MscFile *	mscFile,
		IXMLDOMElement *	pParentNode
	)

Definition at line 122 of file CSnapin.cpp.

{
    IXMLDOMElement *pNodeElement = NULL;
    IXMLDOMElement *pNodesElement = NULL;
    IXMLDOMElement *pStringElement = NULL;
    IXMLDOMElement *pBitmapsElement = NULL;
    IXMLDOMElement *pComponentDatasElement = NULL;
    IXMLDOMElement *pComponentDataElement = NULL;
    IXMLDOMElement *pComponentsElement = NULL;
    POSITION pos;
    CSnapin *SubNode;
    WCHAR szBuffer[32];
    HRESULT hr = S_OK;
 
    /* <Node ID="3" ImageIdx="0" CLSID="{C96401CC-0E17-11D3-885B-00C04F72C717}" Preload="true"> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"Node", pParentNode, &pNodeElement));
    _swprintf(szBuffer, L"%u", m_NodeId);
    CHK_HR(mscFile->CreateAndAddAttributeNode(L"ID", szBuffer, pNodeElement));
    CHK_HR(mscFile->CreateAndAddAttributeNode(L"ImageIdx", L"0", pNodeElement)); /* FIXME */
    CHK_HR(mscFile->CreateAndAddAttributeNode(L"CLSID", CacheEntry()->GuidString().GetString(), pNodeElement));
    CHK_HR(mscFile->CreateAndAddAttributeNode(L"Preload", L"true", pNodeElement)); /* FIXME */
 
    /* <Nodes> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"Nodes", pNodeElement, &pNodesElement));
    pos = m_SubNodes.GetHeadPosition();
    while (pos != NULL)
    {
        SubNode = (CSnapin*)m_SubNodes.GetNext(pos);
        if (SubNode)
            SubNode->SaveNode(mscFile, pNodesElement);
    }
    SAFE_RELEASE(pNodesElement); /* </Nodes> */
 
    /* <String Name="Name" ID="2"/> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"String", pNodeElement, &pStringElement));
    CHK_HR(mscFile->CreateAndAddAttributeNode(L"Name", m_DisplayName.GetString(), pStringElement)); /* FIXME */
    SAFE_RELEASE(pStringElement); /* </String> */
 
    /* <Bitmaps> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"Bitmaps", pNodeElement, &pBitmapsElement));
/*
        <BinaryData Name="Small" BinaryRefIndex="3"/>
        <BinaryData Name="Large" BinaryRefIndex="4"/>
*/
    SAFE_RELEASE(pBitmapsElement); /* </Bitmaps> */
 
    /* <ComponentDatas> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"ComponentDatas", pNodeElement, &pComponentDatasElement));
    /* <ComponentData> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"ComponentData", pComponentDatasElement, &pComponentDataElement));
/*
        <GUID Name="Snapin">{C96401CC-0E17-11D3-885B-00C04F72C717}</GUID>
        <Stream BinaryRefIndex="5"/>
*/
    SAFE_RELEASE(pComponentDataElement); /* </ComponentData> */
    SAFE_RELEASE(pComponentDatasElement); /* </ComponentDatas> */
 
    /* <Components /> */
    CHK_HR(mscFile->CreateAndAddElementNode(L"Components", pNodeElement, &pComponentsElement));
    SAFE_RELEASE(pComponentsElement); /* </Components> */
 
CleanUp:
    SAFE_RELEASE(pNodeElement); /* </Node> */
}

Referenced by CMainWnd::SaveMscFile(), and SaveNode().

SetDisplayName()

void CSnapin::SetDisplayName

(

LPWSTR

pszName

)

Definition at line 43 of file CSnapin.cpp.

{
    m_DisplayName = pszName;
}

Referenced by CConsoleWnd::OnNotify().

Version()

const CAtlString & CSnapin::Version

(

)

const

Definition at line 40 of file CSnapin.cpp.

{ return m_CacheEntry->Version(); }

Member Data Documentation

m_CacheEntry

CSnapinCacheEntry* CSnapin::m_CacheEntry

private

Definition at line 27 of file CSnapin.h.

Referenced by CacheEntry(), CSnapin(), Description(), Name(), Provider(), and Version().

m_DisplayName

CAtlString CSnapin::m_DisplayName

private

Definition at line 28 of file CSnapin.h.

Referenced by CSnapin(), DisplayName(), SaveNode(), and SetDisplayName().

m_NodeId

UINT CSnapin::m_NodeId

private

Definition at line 26 of file CSnapin.h.

Referenced by CSnapin(), GetNodeId(), and SaveNode().

m_SubNodes

CAtlList<CSnapin*> CSnapin::m_SubNodes

Definition at line 46 of file CSnapin.h.

Referenced by CAddDialog::CreateSnapinAliases(), ParseSnapin(), CAddDialog::ReconnectSnapins(), RemoveAllSubnodes(), and SaveNode().

---

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

• base/applications/mmc_new/CSnapin.h
• base/applications/mmc_new/CSnapin.cpp