RunOnceExSection Class Reference

#include <registry.h>

Collaboration diagram for RunOnceExSection:

Public Member Functions
	RunOnceExSection (_In_ CRegKeyEx &hParentKey, _In_ const CStringW &lpSubKeyName)
	RunOnceExSection (_In_ const RunOnceExSection &Section)
BOOL	CloseAndDelete (_In_ CRegKeyEx &hParentKey)
UINT	GetEntryCnt () const
BOOL	Exec (_Inout_ UINT &iCompleteCnt, _In_ const UINT iTotalCnt)

Public Attributes
BOOL	m_bSuccess
ATL::CStringW	m_SectionTitle
CSimpleArray< RunOnceExEntry >	m_EntryList

Private Member Functions
BOOL	HandleValue (_In_ CRegKeyEx &hKey, _In_ const CStringW &ValueName)

Private Attributes
ATL::CStringW	m_SectionName
CRegKeyEx	m_RegKey

Friends
class	RunOnceExInstance
int	RunOnceExSectionCmp (_In_ const void *a, _In_ const void *b)

Detailed Description

Definition at line 51 of file registry.h.

Constructor & Destructor Documentation

RunOnceExSection() [1/2]

RunOnceExSection::RunOnceExSection	(	_In_ CRegKeyEx &	hParentKey,
		_In_ const CStringW &	lpSubKeyName
	)

Definition at line 132 of file registry.cpp.

                                       :
    m_SectionName(lpSubKeyName)
{
    m_bSuccess = FALSE;
    DWORD dwValueNum;
    DWORD dwMaxValueNameLen;
    LSTATUS Error;
    CStringW ValueName;
 
    if (m_RegKey.Open(hParentKey, lpSubKeyName) != ERROR_SUCCESS)
        return;
 
    Error = RegQueryInfoKeyW(m_RegKey, NULL, 0, NULL, NULL, NULL, NULL,
                             &dwValueNum, &dwMaxValueNameLen,
                             NULL, NULL, NULL);
    if (Error != ERROR_SUCCESS)
        return;
 
    for (DWORD i = 0; i < dwValueNum; i++)
    {
        LPWSTR szValueName;
        DWORD dwcchName = dwMaxValueNameLen + 1;
 
        szValueName = ValueName.GetBuffer(dwMaxValueNameLen + 1);
        Error = m_RegKey.EnumValueName(i, szValueName, &dwcchName);
        ValueName.ReleaseBuffer();
 
        if (Error != ERROR_SUCCESS)
        {
            // TODO: error handling
            return;
        }
 
        if (!HandleValue(m_RegKey, ValueName))
            return;
    }
 
    // Sort entries by name in string order.
    qsort(m_EntryList.GetData(), m_EntryList.GetSize(),
          sizeof(RunOnceExEntry), RunOnceExEntryCmp);
 
    m_bSuccess = TRUE;
    return;
}

RunOnceExSection() [2/2]

RunOnceExSection::RunOnceExSection

(

_In_ const RunOnceExSection &

Section

)

Definition at line 180 of file registry.cpp.

                                                                       :
    m_SectionName(Section.m_SectionName),
    m_bSuccess(Section.m_bSuccess),
    m_SectionTitle(Section.m_SectionTitle),
    m_EntryList(Section.m_EntryList)
{
    m_RegKey.Attach(Section.m_RegKey);
}

Member Function Documentation

CloseAndDelete()

BOOL RunOnceExSection::CloseAndDelete

(

_In_ CRegKeyEx &

hParentKey

)

Definition at line 189 of file registry.cpp.

{
    m_RegKey.Close();
    return hParentKey.RecurseDeleteKey(m_SectionName) == ERROR_SUCCESS;
}

Exec()

BOOL RunOnceExSection::Exec	(	_Inout_ UINT &	iCompleteCnt,
		_In_ const UINT	iTotalCnt
	)

Definition at line 201 of file registry.cpp.

{
    BOOL bSuccess = TRUE;
 
    for (int i = 0; i < m_EntryList.GetSize(); i++)
    {
        m_EntryList[i].Delete(m_RegKey);
        bSuccess &= m_EntryList[i].Exec();
        iCompleteCnt++;
        // TODO: the meaning of the third param is still unknown, seems it's always 0.
        if (g_Callback)
            g_Callback(iCompleteCnt, iTotalCnt, NULL);
    }
    return bSuccess;
}

GetEntryCnt()

UINT RunOnceExSection::GetEntryCnt

(

)

const

Definition at line 196 of file registry.cpp.

{
    return m_EntryList.GetSize();
}

HandleValue()

BOOL RunOnceExSection::HandleValue ( _In_ CRegKeyEx &  hKey, _In_ const CStringW &  ValueName  )

private

Definition at line 85 of file registry.cpp.

{
    DWORD dwType;
    DWORD cbData;
 
    // Query data size
    if (hKey.QueryValue(ValueName, &dwType, NULL, &cbData) != ERROR_SUCCESS)
        return FALSE;
 
    // Validate its format and size.
    if (dwType != REG_SZ)
        return TRUE;
 
    if (cbData % sizeof(WCHAR) != 0)
        return FALSE;
 
    CStringW Buffer;
    LPWSTR szBuffer = Buffer.GetBuffer((cbData / sizeof(WCHAR)) + 1);
 
    if (hKey.QueryValue(ValueName, &dwType, szBuffer, &cbData) != ERROR_SUCCESS)
    {
        Buffer.ReleaseBuffer();
        return FALSE;
    }
    szBuffer[cbData / sizeof(WCHAR)] = L'\0';
    Buffer.ReleaseBuffer();
 
    CStringW ExpandStr;
    DWORD dwcchExpand = ExpandEnvironmentStringsW(Buffer, NULL, 0);
    ExpandEnvironmentStringsW(Buffer, ExpandStr.GetBuffer(dwcchExpand + 1), dwcchExpand);
    ExpandStr.ReleaseBuffer();
 
    if (ValueName.IsEmpty())
    {
        // The default value specifies the section title.
        m_SectionTitle = Buffer;
    }
    else
    {
        m_EntryList.Add(RunOnceExEntry(ValueName, ExpandStr));
    }
 
    return TRUE;
}

Referenced by RunOnceExSection().

Friends And Related Function Documentation

RunOnceExInstance

friend class RunOnceExInstance

friend

Definition at line 84 of file registry.h.

RunOnceExSectionCmp

int RunOnceExSectionCmp ( _In_ const void *  a, _In_ const void *  b  )

friend

Definition at line 219 of file registry.cpp.

{
    return lstrcmpW(((RunOnceExSection *)a)->m_SectionName,
                    ((RunOnceExSection *)b)->m_SectionName);
}

Member Data Documentation

m_bSuccess

BOOL RunOnceExSection::m_bSuccess

Definition at line 62 of file registry.h.

Referenced by RunOnceExInstance::HandleSubKey(), and RunOnceExSection().

m_EntryList

CSimpleArray<RunOnceExEntry> RunOnceExSection::m_EntryList

Definition at line 64 of file registry.h.

Referenced by Exec(), GetEntryCnt(), HandleValue(), and RunOnceExSection().

m_RegKey

CRegKeyEx RunOnceExSection::m_RegKey

private

Definition at line 55 of file registry.h.

Referenced by CloseAndDelete(), Exec(), RunOnceExInstance::HandleSubKey(), and RunOnceExSection().

m_SectionName

ATL::CStringW RunOnceExSection::m_SectionName

private

Definition at line 54 of file registry.h.

Referenced by CloseAndDelete().

m_SectionTitle

ATL::CStringW RunOnceExSection::m_SectionTitle

Definition at line 63 of file registry.h.

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

---

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

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