xmldomparser.hpp File Reference

#include <initguid.h>
#include <comdef.h>
#include <ole2.h>
#include <msxml2.h>

Include dependency graph for xmldomparser.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	_COM_NO_STANDARD_GUIDS_
#define	SAFE_RELEASE(p)   do { if ((p)) { (p)->Release(); (p) = NULL; } } while (0)
#define	IID_PPV_ARG(Itype, ppType)   IID_##Itype, (void**)(ppType)
#define	IID_NULL_PPV_ARG(Itype, ppType)   IID_##Itype, NULL, (void**)(ppType)

Functions
HRESULT	InitXMLDOMParser (void)
void	UninitXMLDOMParser (void)
HRESULT	CreateAndInitXMLDOMDocument (IXMLDOMDocument **ppDoc)
BOOL	LoadXMLDocumentFromResource (IXMLDOMDocument *pXMLDom, LPCWSTR lpszXMLResName)
BOOL	LoadXMLDocumentFromFile (IXMLDOMDocument *pXMLDom, LPCWSTR lpszFilename, BOOL bIgnoreErrorsIfNonExistingFile=FALSE)

Macro Definition Documentation

_COM_NO_STANDARD_GUIDS_

#define _COM_NO_STANDARD_GUIDS_

Definition at line 22 of file xmldomparser.hpp.

IID_NULL_PPV_ARG

#define IID_NULL_PPV_ARG	(		Itype,
			ppType
	)		IID_##Itype, NULL, (void**)(ppType)

Definition at line 62 of file xmldomparser.hpp.

Referenced by CStartMenuBtnCtxMenu::CreateContextMenuFromShellFolderPidl(), CDefaultContextMenu::DoPaste(), CDefView::drag_notify_subitem(), CShellLink::DragEnter(), CDefaultContextMenu::Initialize(), CMenuSFToolbar::InternalContextMenu(), CDefView::OnNotify(), CISFBand::OnWinEvent(), PidlToSicIndex(), SHELL_PidlGetIconLocationW(), shellex_get_dataobj(), and TestGetUIObjectOf().

IID_PPV_ARG

#define IID_PPV_ARG	(		Itype,
			ppType
	)		IID_##Itype, (void**)(ppType)

Definition at line 61 of file xmldomparser.hpp.

Referenced by CBandSiteMenu::_AddISFBandToMenu(), CDefViewBckgrndMenu::_bCanPaste(), CDefViewBckgrndMenu::_bIsDesktopBrowserMenu(), CMenuBand::_CallCB(), CMenuDeskBar::_CloseBar(), CFSFolder::_CreateShellExtInstance(), CRecyclerDropTarget::_DoDeleteThreadProc(), CFSDropTarget::_DoDrop(), CFSDropTarget::_DoDropThreadProc(), CBandSiteMenu::_GetBandIdForBuiltinISFBand(), CBandSiteMenu::_GetBandIdFromClsid(), CFSFolder::_GetDropTarget(), CBandSiteMenu::_GetMenuIdFromISFBand(), CDesktopFolder::_GetSFFromPidl(), CTrayBandSite::_Init(), CBandSiteBase::_IsBandDeletable(), CMenuDeskBar::_IsSubMenuParent(), CDefView::_MergeToolbar(), CMenuDeskBar::_OnActivate(), CBandSiteBase::_OnContextMenu(), CMenuDeskBar::_OnNotify(), CMenuBand::_OnPopupSubMenu(), _ReparsePIDL(), CFSDropTarget::_RepositionItems(), CMenuSite::AddBand(), CBandSiteBase::AddBand(), CAddressEditBox::AddComboBoxItem(), CTrayBandSite::AddContextMenus(), CACLMulti::Append(), BindToDesktop(), CShellItem::BindToHandler(), CMergedFolder::BindToObject(), CTrayBandSite::BroadcastOleCommandExec(), CShellDispatch::BrowseForFolder(), CDefaultContextMenu::BrowserFlagsFromVerb(), CShellBrowser::BrowseToPath(), CAddressBand_CreateInstance(), CAddressEditBox_CreateInstance(), CBandProxy_CreateInstance(), CCPLExtractIcon_CreateInstance(), CDefFolderMenu_Create2(), CDrivesExtractIcon_CreateInstance(), CFSExtractIcon_CreateInstance(), CGuidItemExtractIcon_CreateInstance(), CQuickLaunchBand::CloseDW(), CAddressBand::CloseDW(), CNetFolderExtractIcon_CreateInstance(), CNetworkConnections::CNetworkConnections(), CShellItem::Compare(), CCommonFolder< CRegistryFolder, RegPidlEntry, CRegistryFolderExtractIcon >::CompareIDs(), CQuickLaunchBand::ContextSensitiveHelp(), CPrintersExtractIconW_CreateInstane(), CInternetToolbar::CreateAndInitBandProxy(), CreateAndInitXMLDOMDocument(), CreateIDataObject(), CInternetToolbar::CreateMenuBar(), CreateStartMenu(), CZipFolder::CreateViewObject(), CDefView::CreateViewWindow3(), CRecyclerExtractIcon_CreateInstance(), CDesktopThread::DesktopThreadProc(), CExplorerBand::DestroyExplorerBand(), CDefaultContextMenu::DoCreateLink(), CDefaultContextMenu::DoCreateNewFolder(), CDefaultContextMenu::DoDelete(), CShellBrowser::DoFolderOptions(), CDefaultContextMenu::DoPaste(), CDefaultContextMenu::DoRename(), CDefView::drag_notify_subitem(), CShellLink::DragEnter(), CExplorerBand::DragOver(), CFSDropTarget::Drop(), CNetConnectionPropertyUi::EnumComponents(), CNetworkConnections::EnumObjects(), CNetFolder::EnumObjects(), CPrinterFolder::EnumObjects(), CControlPanelFolder::EnumObjects(), CDrivesFolder::EnumObjects(), CDesktopFolder::EnumObjects(), CFSFolder::EnumObjects(), CRecycleBin::EnumObjects(), CMergedFolder::EnumObjects(), CZipFolder::EnumObjects(), CRegFolder::EnumObjects(), CQuickLaunchBand::Exec(), CAddressEditBox::Execute(), CExplorerBand::ExecuteCommand(), ExplorerMessageLoop(), CAddressBand::FileSysChange(), FileSystemBindData_GetFindData(), FileSystemBindData_SetFindData(), CDefView::FillFileMenu(), CAddressEditBox::FillOneLevel(), CQuickLaunchBand::FinalConstruct(), CDrivesFolder::FinalConstruct(), CDesktopFolder::FinalConstruct(), CBandProxy::FindBrowserWindow(), CShellBrowser::FireEvent(), CFolderItem::get_Name(), CShellItem::get_parent_shellfolder(), CFolder::get_Self(), CShellItem::get_shellfolder(), CFSFolder::GetAttributesOf(), CQuickLaunchBand::GetBandInfo(), CShellBrowser::GetBaseBar(), CQuickLaunchBand::GetClassID(), CMenuDeskBar::GetClient(), CQuickLaunchBand::GetCommandString(), CMergedFolder::GetDetailsEx(), CMergedFolder::GetDetailsOf(), GetDisplayName(), CCommonFolder< CRegistryFolder, RegPidlEntry, CRegistryFolderExtractIcon >::GetDisplayNameOf(), GetEnumNTDirectory(), GetEnumRegistryKey(), GetEnumRegistryRoot(), GetExeFromLnk(), GetFavoritesFolder(), CShellBrowser::GetMenuBand(), GetMergedFolder(), CMenuCallback::GetObject(), CDockSite::GetRBBandInfo(), CFolder::GetShellFolder(), CQuickLaunchBand::GetSite(), CQuickLaunchBand::GetSizeMax(), CTravelLog::GetTravelEntry(), CShellBrowser::GetTravelLog(), CNetFolder::GetUIObjectOf(), CDrivesFolder::GetUIObjectOf(), CDesktopFolder::GetUIObjectOf(), CCommonFolder< CRegistryFolder, RegPidlEntry, CRegistryFolderExtractIcon >::GetUIObjectOf(), CQuickLaunchBand::GetWindow(), CDefViewBckgrndMenu::HandleMenuMsg(), CDefViewBckgrndMenu::HandleMenuMsg2(), CTrayBandSite::HasTaskBand(), IDataObject_Constructor(), IDefClF_fnConstructor(), IEGetNameAndFlagsEx(), IEnumFORMATETC_Constructor(), IEnumIDList_Constructor(), IFileSystemBindData_Constructor(), ILGetConnection(), CAutoComplete::Init(), CAddressEditBox::Init(), CFolderItemVerbs::Init(), CFolder::Initialize(), CDefViewBckgrndMenu::Initialize(), CMyDocsFolder::Initialize(), CAdminToolsFolder::Initialize(), CFontsFolder::Initialize(), CControlPanelFolder::Initialize(), CFolderItems::Initialize(), CDefaultContextMenu::Initialize(), CDefView::Initialize(), CEnumIDList::Initialize(), CToolbarProxy::Initialize(), CShellBrowser::Initialize(), CExplorerBand::InitializeExplorerBand(), CNetConnectionPropertyUi::InitializeLANPropertiesUIDlg(), CLanStatus::InitializeNetTaskbarNotifications(), CISFBand::InitializeSFB(), InitIconOverlays(), CSysTray::InitNetShell(), CInternetToolbar::InitNew(), InitShellServices(), CBaseBarSite::InsertBar(), CExplorerBand::InsertItem(), CExplorerBand::InsertSubitems(), CNtObjectFolder::InternalBindToObject(), CRegistryFolder::InternalBindToObject(), CMenuSFToolbar::InternalPopupItem(), CTravelEntry::Invoke(), CAddressEditBox::Invoke(), CDefViewBckgrndMenu::InvokeCommand(), CBandSiteMenu::InvokeCommand(), CCPLItemMenu::InvokeCommand(), CNetConUiObject::InvokeCommand(), CQuickLaunchBand::InvokeCommand(), CShellBrowser::IsBandLoaded(), CQuickLaunchBand::IsDirty(), IShellLink_ConstructFromPath(), IsSameObject(), CMenuFocusManager::IsTrackedWindowOrParent(), CAddressBand::IsWindowOwner(), CQuickLaunchBand::IsWindowOwner(), CFolderItems::Item(), CFolder::Items(), IUnknown_CloseDW(), IUnknown_RelayWinEvent(), IUnknown_ShowDW(), IUnknownIsEqual(), CQuickLaunchBand::Load(), LoadAndInitialize(), CDefaultContextMenu::LoadDynamicContextMenuHandler(), CComCatCachedCategory::LoadFromComCatMgr(), CTrayBandSite::LoadFromStream(), CShellBrowser::LoadHistory(), CShellDispatch::NameSpace(), CExplorerBand::NavigateToCurrentFolder(), CBandProxy::NavigateToPIDL(), CNetConnectionManager::Next(), CEnumExplorerCommand::Next(), CExplorerBand::OnContextMenu(), CDefView::OnContextMenu(), CTrayNotifyWnd::OnCreate(), CDefView::OnCreate(), CTrayWindow::OnCreate(), CShellBrowser::OnDestroy(), CDefView::OnExplorerCommand(), CShellMenuCallback::OnGetSubMenu(), CShellMenuCallback::OnInitMenu(), CInternetToolbar::OnMenuDropDown(), CBaseBar::OnNotify(), CDefView::OnNotify(), CShellBrowser::OnSearch(), CBaseBar::OnSize(), CShellBrowser::OnSize(), CInternetToolbar::OnTipText(), CInternetToolbar::OnTravelBack(), CInternetToolbar::OnTravelForward(), CExplorerBand::OnTreeItemDragging(), CAddressBand::OnWinEvent(), CBaseBarSite::OnWinEvent(), CQuickLaunchBand::OnWinEvent(), CExplorerBand::OnWinEvent(), CInternetToolbar::OnWinIniChange(), CDefView::OpenSelectedItems(), CCommonFolder< CRegistryFolder, RegPidlEntry, CRegistryFolderExtractIcon >::ParseDisplayName(), CFolder::ParseName(), CAddressEditBox::ParseNow(), ParseToolsList(), CMenuDeskBar::Popup(), CMenuSite::ProcessWindowMessage(), CMenuSite::QueryBand(), CInternetToolbar::QueryBand(), CBandSiteMenu::QueryContextMenu(), CStartMenuBtnCtxMenu::QueryContextMenu(), CQuickLaunchBand::QueryContextMenu(), CBaseBar::QueryService(), CBaseBarSite::QueryService(), CBrandBand::QueryService(), CQuickLaunchBand::QueryStatus(), CShellBrowser::QueryStatus(), CAddressBand::Refresh(), CShellBrowser::Refresh2(), RegisterComCat(), CBaseBarSite::RemoveBand(), CBaseBar::ReserveBorderSpace(), CInternetToolbar::ReserveBorderSpace(), CQuickLaunchBand::ResizeBorderDW(), CInternetToolbar::ResizeBorderDW(), RSHELL_CStartMenu_CreateInstance(), CQuickLaunchBand::Save(), CShellBrowser::SaveHistory(), CNewMenu::SelectNewItem(), CBaseBar::SetClient(), CMenuDeskBar::SetClient(), CMenuBand::SetClient(), CInternetToolbar::SetCommandTarget(), CBandSiteBase::SetDeskBarSite(), CBaseBarSite::SetDeskBarSite(), CShellBrowser::SetMenuSB(), CAddressEditBox::SetOwner(), CBandSiteMenu::SetOwner(), CQuickLaunchBand::SetSite(), CToolsBand::SetSite(), CBrandBand::SetSite(), CAddressBand::SetSite(), CMenuDeskBar::SetSite(), CMenuBand::SetSite(), CInternetToolbar::SetSite(), CTaskBand::SetSite(), SH_ShowDriveProperties(), SH_ShowPropertiesDialog(), SHBindToFolder(), SHCreateDesktop(), SHCreateFileExtractIconW(), SHCreateShellFolderView(), SHCreateShellFolderViewEx(), SHCreateShellItem(), SHELL32_BindToSF(), SHELL32_CoCreateInitSF(), SHELL32_CompareChildren(), SHELL32_CreatePidlFromBindCtx(), SHELL32_GetDisplayNameOfChild(), SHELL32_GetFSItemAttributes(), SHELL32_ParseNextElement(), SHELL_execute(), SHELL_PidlGetIconLocationW(), shellex_get_dataobj(), shellex_load_object_and_run(), shellex_run_context_menu_default(), SHEmptyRecycleBinW(), SHEnumClassesOfCategories(), SHFileOperationW(), SHGetDesktopFolder(), CTrayBandSite::Show(), CBaseBarSite::ShowBand(), CShellBrowser::ShowBand(), CQuickLaunchBand::ShowDW(), START_TEST(), test_ACListISF_CURRENTDIR(), test_ACListISF_DESKTOP(), test_ACListISF_FAVORITES(), test_ACListISF_FILESYSDIRS(), test_ACListISF_FILESYSONLY(), test_ACListISF_MYCOMPUTER(), test_ACListISF_NONE(), test_checklinkpath(), test_ExpectFolders_imp(), test_IACLCustomMRU_Basics(), test_IACLCustomMRU_Continue(), test_IACLCustomMRU_ExtraChars(), test_IACLCustomMRU_UpdateOrder(), test_iconlocation(), TestCompareIDList(), TestDescription(), TestDesktopFolder(), TestGetUIObjectOf(), TestInitialize(), TestShellFolder(), TestUninitialized(), CDownloadManager::ThreadFunc(), CHardErrorThread::ThreadProc(), CDefaultContextMenu::TryToBrowse(), CMenuBand::UIActivateIO(), UnregisterComCat(), CTravelEntry::Update(), CExplorerBand::UpdateBrowser(), CMenuFocusManager::UpdateFocus(), CMenuToolbarBase::UpdateImageLists(), UpdateStartMenu(), CShellBrowser::WindowProc(), and wmain().

SAFE_RELEASE

#define SAFE_RELEASE

(

p

)

do { if ((p)) { (p)->Release(); (p) = NULL; } } while (0)

Definition at line 32 of file xmldomparser.hpp.

Referenced by FillListView(), LoadXMLDocumentFromFile(), LoadXMLDocumentFromResource(), and ParseToolsList().

Function Documentation

CreateAndInitXMLDOMDocument()

HRESULT CreateAndInitXMLDOMDocument

(

IXMLDOMDocument **

ppDoc

)

Definition at line 64 of file xmldomparser.cpp.

Referenced by FillListView().

{
    HRESULT hr = CoCreateInstance(CLSID_DOMDocument30, // __uuidof(DOMDocument30), // NOTE: Do not use DOMDocument60 if you want MSConfig working by default on XP.
                                  NULL,
                                  CLSCTX_INPROC_SERVER,
                                  IID_PPV_ARG(IXMLDOMDocument, ppDoc) /* IID_PPV_ARGS(ppDoc) */);
    if (!SUCCEEDED(hr))
        return hr;

    /* These methods should not fail so don't inspect result */
    (*ppDoc)->put_async(VARIANT_FALSE);
    (*ppDoc)->put_validateOnParse(VARIANT_FALSE);
    (*ppDoc)->put_resolveExternals(VARIANT_FALSE);

    return hr;
}

InitXMLDOMParser()

HRESULT InitXMLDOMParser

(

void

)

Definition at line 51 of file xmldomparser.cpp.

Referenced by FillListView().

{
    return CoInitialize(NULL);
}

LoadXMLDocumentFromFile()

BOOL LoadXMLDocumentFromFile	(	IXMLDOMDocument *	pXMLDom,
		LPCWSTR	lpszFilename,
		BOOL	bIgnoreErrorsIfNonExistingFile = FALSE
	)

Definition at line 143 of file xmldomparser.cpp.

Referenced by FillListView().

{
    VARIANT_BOOL Success = VARIANT_FALSE;
    _variant_t varFileName(lpszFilename);

    if (!pDoc)
        return FALSE;

    if (SUCCEEDED(pDoc->load(varFileName, &Success)) && (Success != VARIANT_TRUE))
    {
        IXMLDOMParseError* pXMLErr    = NULL;
        LONG               lErrorCode = 0L;

        if (SUCCEEDED(pDoc->get_parseError(&pXMLErr)) &&
            SUCCEEDED(pXMLErr->get_errorCode(&lErrorCode)))
        {
            if ( !bIgnoreErrorsIfNonExistingFile ||
                ((lErrorCode != _HRESULT_TYPEDEF_(0x800C0006) /* INET_E_OBJECT_NOT_FOUND */) &&
                 (lErrorCode != HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND))) )
            {
                _bstr_t bstrErr;

                if (SUCCEEDED(pXMLErr->get_reason(&bstrErr.GetBSTR())))
                {
                    LPWSTR lpszStr = FormatString(L"Failed to load DOM from '%wS': %wS", lpszFilename, (wchar_t*)bstrErr);
                    MessageBoxW(NULL, lpszStr, L"Error", MB_ICONERROR | MB_OK);
                    MemFree(lpszStr);
                }
            }
        }

        SAFE_RELEASE(pXMLErr);
    }

    return (Success == VARIANT_TRUE);
}

LoadXMLDocumentFromResource()

BOOL LoadXMLDocumentFromResource	(	IXMLDOMDocument *	pXMLDom,
		LPCWSTR	lpszXMLResName
	)

Definition at line 82 of file xmldomparser.cpp.

Referenced by FillListView().

{
    VARIANT_BOOL Success = VARIANT_FALSE;
    HRSRC   hRes;
    HGLOBAL handle;
    LPVOID  lpXMLRes;
    _bstr_t bstrXMLRes;

    if (!pDoc)
        return FALSE;

    // hRes = FindResourceExW(NULL, RT_HTML, lpszXMLResName, MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL));
    hRes = FindResourceW(NULL, lpszXMLResName, RT_HTML);
    if (hRes == NULL)
        return FALSE;

    handle = LoadResource(NULL, hRes);
    if (handle == NULL)
        return FALSE;

    lpXMLRes = LockResource(handle);
    if (lpXMLRes == NULL)
        goto Cleanup;

    /* Convert the resource to UNICODE if needed */
    if (!IsTextUnicode(lpXMLRes, SizeofResource(NULL, hRes), NULL))
        bstrXMLRes.Attach(ConvertUTF8StringToBSTR((LPCSTR)lpXMLRes));
    else
        bstrXMLRes = (LPCWSTR)lpXMLRes;

    if (SUCCEEDED(pDoc->loadXML(bstrXMLRes, &Success)) && (Success != VARIANT_TRUE))
    {
        IXMLDOMParseError* pXMLErr = NULL;
        _bstr_t            bstrErr;

        if (SUCCEEDED(pDoc->get_parseError(&pXMLErr)) &&
            SUCCEEDED(pXMLErr->get_reason(&bstrErr.GetBSTR())))
        {
            LPWSTR lpszStr = NULL;

            if (IS_INTRESOURCE((ULONG_PTR)lpszXMLResName))
                lpszStr = FormatString(L"Failed to load DOM from resource '#%u': %wS", lpszXMLResName, (wchar_t*)bstrErr);
            else
                lpszStr = FormatString(L"Failed to load DOM from resource '%wS': %wS", lpszXMLResName, (wchar_t*)bstrErr);

            MessageBoxW(NULL, lpszStr, L"Error", MB_ICONERROR | MB_OK);

            MemFree(lpszStr);
        }

        SAFE_RELEASE(pXMLErr);
    }

Cleanup:
    FreeResource(handle);

    return (Success == VARIANT_TRUE);
}

UninitXMLDOMParser()

void UninitXMLDOMParser

(

void

)

Definition at line 57 of file xmldomparser.cpp.

Referenced by FillListView().

{
    CoUninitialize();
    return;
}