#include <mscfile.h>

Collaboration diagram for MscFile:

[legend]

Public Member Functions
	MscFile (PCWSTR pszFileName)

	~MscFile ()

HRESULT	CreateAndInitDOM ()

HRESULT	CreateElement (PCWSTR wszName, IXMLDOMElement **ppElement)

HRESULT	AppendChildToParent (IXMLDOMNode pChild, IXMLDOMNode pParent=NULL)

HRESULT	CreateAndAddPINode (PCWSTR wszTarget, PCWSTR wszData)

HRESULT	CreateAndAddCommentNode (PCWSTR wszComment)

HRESULT	CreateAndAddAttributeNode (PCWSTR wszName, PCWSTR wszValue, IXMLDOMElement *pParent)

HRESULT	CreateAndAddTextNode (PCWSTR wszText, IXMLDOMNode *pParent)

HRESULT	CreateAndAddCDATANode (PCWSTR wszCDATA, IXMLDOMNode *pParent)

HRESULT	CreateAndAddElementNode (PCWSTR wszName, IXMLDOMNode pParent, IXMLDOMElement *ppElement=NULL)

HRESULT	SaveWindowPlacement (CWindow pWindow, IXMLDOMElement pParentNode)

HRESULT	LoadDOM ()

HRESULT	SaveDOM ()

Private Member Functions
HRESULT	VariantFromString (PCWSTR wszValue, VARIANT &Variant)

LPWSTR	ShowCmdToString (int nShowCmd)

Private Attributes
VARIANT	m_varFileName

IXMLDOMDocument *	m_pDocument

Detailed Description

Definition at line 17 of file mscfile.h.

Constructor & Destructor Documentation

◆ MscFile()

MscFile::MscFile ( PCWSTR pszFileName )

Definition at line 15 of file mscfile.cpp.

{
    m_pDocument = NULL;
    VariantInit(&m_varFileName);
    VariantFromString(pszFileName, m_varFileName);
}

◆ ~MscFile()

MscFile::~MscFile ( )

Definition at line 22 of file mscfile.cpp.

{
    VariantClear(&m_varFileName);
    SAFE_RELEASE(m_pDocument);
}

Member Function Documentation

◆ AppendChildToParent()

HRESULT MscFile::AppendChildToParent	(	IXMLDOMNode *	pChild,
		IXMLDOMNode *	pParent = `NULL`
	)

Definition at line 81 of file mscfile.cpp.

{
    HRESULT hr = S_OK;
    IXMLDOMNode *pChildOut = NULL;
    if (pParent == NULL)
        CHK_HR(m_pDocument->appendChild(pChild, &pChildOut));
    else
        CHK_HR(pParent->appendChild(pChild, &pChildOut));
 
CleanUp:
    SAFE_RELEASE(pChildOut);
    return hr;
}

Referenced by CreateAndAddCDATANode(), CreateAndAddCommentNode(), CreateAndAddElementNode(), CreateAndAddPINode(), CreateAndAddTextNode(), and CMainWnd::SaveMscFile().

◆ CreateAndAddAttributeNode()

HRESULT MscFile::CreateAndAddAttributeNode	(	PCWSTR	wszName,
		PCWSTR	wszValue,
		IXMLDOMElement *	pParent
	)

Definition at line 135 of file mscfile.cpp.

    {
        HRESULT hr = S_OK;
        IXMLDOMAttribute *pAttribute = NULL;
        IXMLDOMAttribute *pAttributeOut = NULL; // Out param that is not used
 
        BSTR bstrName = NULL;
        VARIANT varValue;
        VariantInit(&varValue);
 
        bstrName = SysAllocString(wszName);
        CHK_ALLOC(bstrName);
        CHK_HR(VariantFromString(wszValue, varValue));
 
        CHK_HR(m_pDocument->createAttribute(bstrName, &pAttribute));
        CHK_HR(pAttribute->put_value(varValue));
        CHK_HR(pParent->setAttributeNode(pAttribute, &pAttributeOut));
 
    CleanUp:
        SAFE_RELEASE(pAttribute);
        SAFE_RELEASE(pAttributeOut);
        SysFreeString(bstrName);
        VariantClear(&varValue);
        return hr;
    }

Referenced by CMainWnd::SaveMscFile(), CSnapin::SaveNode(), CConsoleWnd::SaveView(), and SaveWindowPlacement().

◆ CreateAndAddCDATANode()

HRESULT MscFile::CreateAndAddCDATANode	(	PCWSTR	wszCDATA,
		IXMLDOMNode *	pParent
	)

Definition at line 180 of file mscfile.cpp.

    {
        HRESULT hr = S_OK;
        IXMLDOMCDATASection *pCDATA = NULL;
 
        BSTR bstrCDATA = SysAllocString(wszCDATA);
        CHK_ALLOC(bstrCDATA);
 
        CHK_HR(m_pDocument->createCDATASection(bstrCDATA, &pCDATA));
        CHK_HR(AppendChildToParent(pCDATA, pParent));
 
    CleanUp:
        SAFE_RELEASE(pCDATA);
        SysFreeString(bstrCDATA);
        return hr;
    }

◆ CreateAndAddCommentNode()

HRESULT MscFile::CreateAndAddCommentNode ( PCWSTR wszComment )

Definition at line 117 of file mscfile.cpp.

    {
        HRESULT hr = S_OK;
        IXMLDOMComment *pComment = NULL;
 
        BSTR bstrComment = SysAllocString(wszComment);
        CHK_ALLOC(bstrComment);
        
        CHK_HR(m_pDocument->createComment(bstrComment, &pComment));
        CHK_HR(AppendChildToParent(pComment, m_pDocument));
 
    CleanUp:
        SAFE_RELEASE(pComment);
        SysFreeString(bstrComment);
        return hr;
    }

◆ CreateAndAddElementNode()

HRESULT MscFile::CreateAndAddElementNode	(	PCWSTR	wszName,
		IXMLDOMNode *	pParent,
		IXMLDOMElement **	ppElement = `NULL`
	)

Definition at line 199 of file mscfile.cpp.

    {
        HRESULT hr = S_OK;
        IXMLDOMElement* pElement = NULL;
 
        CHK_HR(CreateElement(wszName, &pElement));
        CHK_HR(AppendChildToParent(pElement, pParent));
 
    CleanUp:
        if (ppElement)
            *ppElement = pElement;  // Caller is repsonsible to release this element.
        else
            SAFE_RELEASE(pElement); // Caller is not interested on this element, so release it.
 
        return hr;
    }

Referenced by CMainWnd::SaveMscFile(), CSnapin::SaveNode(), CConsoleWnd::SaveView(), and SaveWindowPlacement().

◆ CreateAndAddPINode()

HRESULT MscFile::CreateAndAddPINode	(	PCWSTR	wszTarget,
		PCWSTR	wszData
	)

Definition at line 97 of file mscfile.cpp.

{
    HRESULT hr = S_OK;
    IXMLDOMProcessingInstruction *pPI = NULL;
 
    BSTR bstrTarget = SysAllocString(wszTarget);
    BSTR bstrData = SysAllocString(wszData);
    CHK_ALLOC(bstrTarget && bstrData);
    
    CHK_HR(m_pDocument->createProcessingInstruction(bstrTarget, bstrData, &pPI));
    CHK_HR(AppendChildToParent(pPI, m_pDocument));
 
CleanUp:
    SAFE_RELEASE(pPI);
    SysFreeString(bstrTarget);
    SysFreeString(bstrData);
    return hr;
}

Referenced by CMainWnd::SaveMscFile().

◆ CreateAndAddTextNode()

HRESULT MscFile::CreateAndAddTextNode	(	PCWSTR	wszText,
		IXMLDOMNode *	pParent
	)

Definition at line 162 of file mscfile.cpp.

    {
        HRESULT hr = S_OK;    
        IXMLDOMText *pText = NULL;
 
        BSTR bstrText = SysAllocString(wszText);
        CHK_ALLOC(bstrText);
 
        CHK_HR(m_pDocument->createTextNode(bstrText, &pText));
        CHK_HR(AppendChildToParent(pText, pParent));
 
    CleanUp:
        SAFE_RELEASE(pText);
        SysFreeString(bstrText);
        return hr;
    }

Referenced by CMainWnd::SaveMscFile().

◆ CreateAndInitDOM()

HRESULT MscFile::CreateAndInitDOM ( )

Definition at line 46 of file mscfile.cpp.

{
    HRESULT hr = CoCreateInstance(CLSID_DOMDocument30,
                                  NULL,
                                  CLSCTX_INPROC_SERVER,
                                  IID_IXMLDOMDocument,
                                  (void**)&m_pDocument);
    if (SUCCEEDED(hr))
    {
        m_pDocument->put_async(VARIANT_FALSE);  
        m_pDocument->put_validateOnParse(VARIANT_FALSE);
        m_pDocument->put_resolveExternals(VARIANT_FALSE);
        m_pDocument->put_preserveWhiteSpace(VARIANT_TRUE);
    }
    return hr;
}

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

◆ CreateElement()

HRESULT MscFile::CreateElement	(	PCWSTR	wszName,
		IXMLDOMElement **	ppElement
	)

Definition at line 65 of file mscfile.cpp.

{
    HRESULT hr = S_OK;
    *ppElement = NULL;
 
    BSTR bstrName = SysAllocString(wszName);
    CHK_ALLOC(bstrName);
    CHK_HR(m_pDocument->createElement(bstrName, ppElement));
 
CleanUp:
    SysFreeString(bstrName);
    return hr;
}

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

◆ LoadDOM()

HRESULT MscFile::LoadDOM ( )

Definition at line 314 of file mscfile.cpp.

{
    IXMLDOMParseError *pXMLErr = NULL;
    BSTR bstrErr = NULL;
    VARIANT_BOOL varStatus;
    HRESULT hr = S_OK;
 
    hr = m_pDocument->load(m_varFileName, &varStatus);
    if (varStatus != VARIANT_TRUE)
    {
        // Failed to load xml, get last parsing error
        CHK_HR(m_pDocument->get_parseError(&pXMLErr));
        CHK_HR(pXMLErr->get_reason(&bstrErr));
    }
 
CleanUp:
    SAFE_RELEASE(pXMLErr);
    SysFreeString(bstrErr);
 
    return hr;
}

Referenced by CMainWnd::LoadMscFile().

◆ SaveDOM()

HRESULT MscFile::SaveDOM ( )

Definition at line 337 of file mscfile.cpp.

{
    return m_pDocument->save(m_varFileName);
}

Referenced by CMainWnd::SaveMscFile().

◆ SaveWindowPlacement()

HRESULT MscFile::SaveWindowPlacement	(	CWindow *	pWindow,
		IXMLDOMElement *	pParentNode
	)

Definition at line 264 of file mscfile.cpp.

{
    IXMLDOMElement *pWindowPlacement = NULL;
    IXMLDOMElement *pPointElement = NULL;
    IXMLDOMElement *pRectangleElement = NULL;
    WINDOWPLACEMENT wndpl;
    WCHAR szBuffer[32];
    HRESULT hr = S_OK;
 
    pWindow->GetWindowPlacement(&wndpl);
 
    CHK_HR(CreateAndAddElementNode(L"WindowPlacement", pParentNode, &pWindowPlacement));
    CHK_HR(CreateAndAddAttributeNode(L"ShowCommand", ShowCmdToString(wndpl.showCmd), pWindowPlacement));
 
    CHK_HR(CreateAndAddElementNode(L"Point", pWindowPlacement, &pPointElement));
    CHK_HR(CreateAndAddAttributeNode(L"Name", L"MinPosition", pPointElement));
    _swprintf(szBuffer, L"%ld", wndpl.ptMinPosition.x);
    CHK_HR(CreateAndAddAttributeNode(L"X", szBuffer, pPointElement));
    _swprintf(szBuffer, L"%ld", wndpl.ptMinPosition.y);
    CHK_HR(CreateAndAddAttributeNode(L"Y", szBuffer, pPointElement));
    SAFE_RELEASE(pPointElement);
 
    CHK_HR(CreateAndAddElementNode(L"Point", pWindowPlacement, &pPointElement));
    CHK_HR(CreateAndAddAttributeNode(L"Name", L"MaxPosition", pPointElement));
    _swprintf(szBuffer, L"%ld", wndpl.ptMaxPosition.x);
    CHK_HR(CreateAndAddAttributeNode(L"X", szBuffer, pPointElement));
    _swprintf(szBuffer, L"%ld", wndpl.ptMaxPosition.y);
    CHK_HR(CreateAndAddAttributeNode(L"Y", szBuffer, pPointElement));
    SAFE_RELEASE(pPointElement);
 
    /* <Rectangle Name="NormalPosition" Top="0" Bottom="508" Left="0" Right="1186"/> */
    CHK_HR(CreateAndAddElementNode(L"Rectangle", pWindowPlacement, &pRectangleElement));
    CHK_HR(CreateAndAddAttributeNode(L"Name", L"NormalPosition", pRectangleElement));
    _swprintf(szBuffer, L"%ld", wndpl.rcNormalPosition.top);
    CHK_HR(CreateAndAddAttributeNode(L"Top", szBuffer, pRectangleElement));
    _swprintf(szBuffer, L"%ld", wndpl.rcNormalPosition.bottom);
    CHK_HR(CreateAndAddAttributeNode(L"Bottom", szBuffer, pRectangleElement));
    _swprintf(szBuffer, L"%ld", wndpl.rcNormalPosition.left);
    CHK_HR(CreateAndAddAttributeNode(L"Left", szBuffer, pRectangleElement));
    _swprintf(szBuffer, L"%ld", wndpl.rcNormalPosition.right);
    CHK_HR(CreateAndAddAttributeNode(L"Right", szBuffer, pRectangleElement));
    SAFE_RELEASE(pRectangleElement);
 
CleanUp:
    SAFE_RELEASE(pWindowPlacement);
 
    return hr;
}

Referenced by CMainWnd::SaveMscFile(), and CConsoleWnd::SaveView().

◆ ShowCmdToString()

LPWSTR MscFile::ShowCmdToString ( int nShowCmd )

private

Definition at line 218 of file mscfile.cpp.

{
    switch (nShowCmd)
    {
        case SW_HIDE:
            return (LPWSTR)L"SW_HIDE";
 
        case SW_SHOWNORMAL:
            return (LPWSTR)L"SW_SHOWNORMAL";
 
        case SW_SHOWMINIMIZED:
            return (LPWSTR)L"SW_SHOWMINIMIZED";
 
        case SW_SHOWMAXIMIZED:
            return (LPWSTR)L"SW_SHOWMAXIMIZED";
 
        case SW_SHOWNOACTIVATE:
            return (LPWSTR)L"SW_SHOWNOACTIVATE";
 
        case SW_SHOW:
            return (LPWSTR)L"SW_SHOW";
 
        case SW_MINIMIZE:
            return (LPWSTR)L"SW_MINIMIZE";
        
        case SW_SHOWMINNOACTIVE:
            return (LPWSTR)L"SW_SHOWMINNOACTIVE";
        
        case SW_SHOWNA:
            return (LPWSTR)L"SW_SHOWNA";
 
        case SW_RESTORE:
            return (LPWSTR)L"SW_RESTORE";
 
        case SW_SHOWDEFAULT:
            return (LPWSTR)L"SW_SHOWDEFAULT";
 
        case SW_FORCEMINIMIZE:
            return (LPWSTR)L"SW_FORCEMINIMIZE";
    }
 
    return (LPWSTR)L"-1";
}

Referenced by SaveWindowPlacement().

◆ VariantFromString()

HRESULT MscFile::VariantFromString	(	PCWSTR	wszValue,
		VARIANT &	Variant
	)

private

Definition at line 31 of file mscfile.cpp.

{
    HRESULT hr = S_OK;
    BSTR bstr = SysAllocString(wszValue);
    CHK_ALLOC(bstr);
    
    V_VT(&Variant)   = VT_BSTR;
    V_BSTR(&Variant) = bstr;
 
CleanUp:
    return hr;
}

Referenced by CreateAndAddAttributeNode(), and MscFile().

Member Data Documentation

◆ m_pDocument

IXMLDOMDocument* MscFile::m_pDocument

private

Definition at line 21 of file mscfile.h.

Referenced by AppendChildToParent(), CreateAndAddAttributeNode(), CreateAndAddCDATANode(), CreateAndAddCommentNode(), CreateAndAddPINode(), CreateAndAddTextNode(), CreateAndInitDOM(), CreateElement(), LoadDOM(), MscFile(), SaveDOM(), and ~MscFile().

◆ m_varFileName

VARIANT MscFile::m_varFileName

private

Definition at line 20 of file mscfile.h.

Referenced by LoadDOM(), MscFile(), SaveDOM(), and ~MscFile().

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

base/applications/mmc_new/mscfile.h
base/applications/mmc_new/mscfile.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MscFile()

◆ ~MscFile()

Member Function Documentation

◆ AppendChildToParent()

◆ CreateAndAddAttributeNode()

◆ CreateAndAddCDATANode()

◆ CreateAndAddCommentNode()

◆ CreateAndAddElementNode()

◆ CreateAndAddPINode()

◆ CreateAndAddTextNode()

◆ CreateAndInitDOM()

◆ CreateElement()

◆ LoadDOM()

◆ SaveDOM()

◆ SaveWindowPlacement()

◆ ShowCmdToString()

◆ VariantFromString()

Member Data Documentation

◆ m_pDocument

◆ m_varFileName