RunOnceExInstance Class Reference

#include <registry.h>

Collaboration diagram for RunOnceExInstance:

Public Member Functions
	RunOnceExInstance (_In_ HKEY BaseKey)
BOOL	Exec (_In_opt_ HWND hwnd)
BOOL	Run (_In_ BOOL bSilence)

Public Attributes
BOOL	m_bSuccess
CSimpleArray< RunOnceExSection >	m_SectionList
CStringW	m_Title
DWORD	m_dwFlags
BOOL	m_bShowDialog

Private Member Functions
BOOL	HandleSubKey (_In_ CRegKeyEx &hKey, _In_ const CStringW &SubKeyName)

Private Attributes
CRegKeyEx	m_RegKey

Detailed Description

Definition at line 87 of file registry.h.

Constructor & Destructor Documentation

RunOnceExInstance()

RunOnceExInstance::RunOnceExInstance

(

_In_ HKEY

BaseKey

)

Definition at line 227 of file registry.cpp.

{
    m_bSuccess = FALSE;
    DWORD dwSubKeyNum;
    DWORD dwMaxSubKeyNameLen;
    LSTATUS Error;
    CStringW SubKeyName;
 
    Error = m_RegKey.Open(BaseKey,
                          L"Software\\Microsoft\\Windows\\CurrentVersion\\RunOnceEx\\");
    if (Error != ERROR_SUCCESS)
    {
        return;
    }
 
    ULONG cchTitle;
    Error = m_RegKey.QueryStringValue(L"Title", NULL, &cchTitle);
    if (Error == ERROR_SUCCESS)
    {
        Error = m_RegKey.QueryStringValue(L"Title", m_Title.GetBuffer(cchTitle + 1), &cchTitle);
        m_Title.ReleaseBuffer();
        if (Error != ERROR_SUCCESS)
            return;
    }
 
    Error = m_RegKey.QueryDWORDValue(L"Flags", m_dwFlags);
    if (Error != ERROR_SUCCESS)
    {
        m_dwFlags = 0;
    }
 
    Error = RegQueryInfoKeyW(m_RegKey, NULL, 0, NULL,
                             &dwSubKeyNum, &dwMaxSubKeyNameLen,
                             NULL, NULL, NULL, NULL, NULL, NULL);
    if (Error != ERROR_SUCCESS)
        return;
 
    m_bShowDialog = FALSE;
 
    for (DWORD i = 0; i < dwSubKeyNum; i++)
    {
        LPWSTR szSubKeyName;
        DWORD dwcchName = dwMaxSubKeyNameLen + 1;
 
        szSubKeyName = SubKeyName.GetBuffer(dwMaxSubKeyNameLen + 1);
        Error = m_RegKey.EnumKey(i, szSubKeyName, &dwcchName);
        SubKeyName.ReleaseBuffer();
 
        if (Error != ERROR_SUCCESS)
        {
            // TODO: error handling
            return;
        }
 
        if (!HandleSubKey(m_RegKey, SubKeyName))
            return;
    }
 
    // Sort sections by name in string order.
    qsort(m_SectionList.GetData(), m_SectionList.GetSize(),
          sizeof(RunOnceExSection), RunOnceExSectionCmp);
 
    m_bSuccess = TRUE;
    return;
}

Member Function Documentation

Exec()

BOOL RunOnceExInstance::Exec

(

_In_opt_ HWND

hwnd

)

Definition at line 293 of file registry.cpp.

{
    BOOL bSuccess = TRUE;
 
    UINT TotalCnt = 0;
    UINT CompleteCnt = 0;
    for (int i = 0; i < m_SectionList.GetSize(); i++)
    {
        TotalCnt += m_SectionList[i].GetEntryCnt();
    }
 
    // Execute items from registry one by one, and remove them.
    for (int i = 0; i < m_SectionList.GetSize(); i++)
    {
        if (hwnd)
            SendMessageW(hwnd, WM_SETINDEX, i, 0);
 
        bSuccess &= m_SectionList[i].Exec(CompleteCnt, TotalCnt);
        m_SectionList[i].CloseAndDelete(m_RegKey);
    }
 
    m_RegKey.DeleteValue(L"Title");
    m_RegKey.DeleteValue(L"Flags");
 
    // Notify the dialog all sections are handled.
    if (hwnd)
        SendMessageW(hwnd, WM_SETINDEX, m_SectionList.GetSize(), bSuccess);
    return bSuccess;
}

Referenced by Run(), and RunOnceExExecThread().

HandleSubKey()

BOOL RunOnceExInstance::HandleSubKey ( _In_ CRegKeyEx &  hKey, _In_ const CStringW &  SubKeyName  )

private

Definition at line 339 of file registry.cpp.

{
    RunOnceExSection Section(hKey, SubKeyName);
    if (!Section.m_bSuccess)
    {
        return FALSE;
    }
 
    if (!Section.m_SectionTitle.IsEmpty())
    {
        m_bShowDialog = TRUE;
    }
    m_SectionList.Add(Section);
 
    // The copy constructor of RunOnceExSection didn't detach
    // the m_RegKey while it's attached to the one in the array.
    // So we have to detach it manually.
    Section.m_RegKey.Detach();
    return TRUE;
}

Referenced by RunOnceExInstance().

Run()

BOOL RunOnceExInstance::Run

(

_In_ BOOL

bSilence

)

Definition at line 323 of file registry.cpp.

{
    if (bSilence ||
        (m_dwFlags & FLAGS_NO_STAT_DIALOG) ||
        !m_bShowDialog)
    {
        return Exec(NULL);
    }
    else
    {
        // The dialog is responsible to create a thread and execute.
        ProgressDlg dlg(*this);
        return dlg.RunDialogBox();
    }
}

Member Data Documentation

m_bShowDialog

BOOL RunOnceExInstance::m_bShowDialog

Definition at line 101 of file registry.h.

Referenced by HandleSubKey(), Run(), and RunOnceExInstance().

m_bSuccess

BOOL RunOnceExInstance::m_bSuccess

Definition at line 97 of file registry.h.

Referenced by RunOnceExInstance().

m_dwFlags

DWORD RunOnceExInstance::m_dwFlags

Definition at line 100 of file registry.h.

Referenced by Run(), and RunOnceExInstance().

m_RegKey

CRegKeyEx RunOnceExInstance::m_RegKey

private

Definition at line 90 of file registry.h.

Referenced by Exec(), and RunOnceExInstance().

m_SectionList

CSimpleArray<RunOnceExSection> RunOnceExInstance::m_SectionList

Definition at line 98 of file registry.h.

Referenced by Exec(), HandleSubKey(), ProgressDlg::ProcessWindowMessage(), ProgressDlg::RunDialogBox(), and RunOnceExInstance().

m_Title

CStringW RunOnceExInstance::m_Title

Definition at line 99 of file registry.h.

Referenced by ProgressDlg::ProcessWindowMessage(), and RunOnceExInstance().

---

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

• dll/win32/iernonce/include/registry.h
• dll/win32/iernonce/registry.cpp