CicRegKey Class Reference

#include <cicreg.h>

Collaboration diagram for CicRegKey:

Public Member Functions
	CicRegKey ()
	~CicRegKey ()
	operator HKEY ()
LSTATUS	Open (HKEY hKey, LPCTSTR lpSubKey, REGSAM samDesired=KEY_READ)
LSTATUS	Create (HKEY hKey, LPCTSTR lpSubKey)
void	Close ()
LSTATUS	QueryDword (LPCTSTR pszValueName, LPDWORD pdwValue)
LSTATUS	SetDword (LPCTSTR pszValueName, DWORD dwValue)
LSTATUS	QuerySz (LPCTSTR pszValueName, LPTSTR pszValue, DWORD cchValueMax)
LSTATUS	SetSz (LPCTSTR pszValueName, LPCTSTR pszValue)
LSTATUS	SetSzW (LPCWSTR pszValueName, LPCWSTR pszValue)
LSTATUS	DeleteValue (LPCTSTR pszValueName)
LSTATUS	DeleteSubKey (LPCTSTR lpSubKey)
LSTATUS	RecurseDeleteKey (LPCTSTR lpSubKey)
LSTATUS	EnumValue (DWORD dwIndex, LPTSTR lpValueName, DWORD cchValueName)

Public Attributes
HKEY	m_hKey

Detailed Description

Definition at line 10 of file cicreg.h.

Constructor & Destructor Documentation

CicRegKey()

CicRegKey::CicRegKey ( )

inline

Definition at line 15 of file cicreg.h.

: m_hKey(NULL) { }

~CicRegKey()

CicRegKey::~CicRegKey ( )

inline

Definition at line 16 of file cicreg.h.

{ Close(); }

Member Function Documentation

Close()

void CicRegKey::Close ( )

inline

Definition at line 89 of file cicreg.h.

{
    if (!m_hKey)
        return;
 
    ::RegCloseKey(m_hKey);
    m_hKey = NULL;
}

Referenced by _cicRegKey_Create(), _cicRegKey_Open(), _cicRegKey_RecurseDeleteKey(), and ~CicRegKey().

Create()

LSTATUS CicRegKey::Create ( HKEY  hKey, LPCTSTR  lpSubKey  )

inline

Definition at line 56 of file cicreg.h.

{
    return _cicRegKey_Create(*this, hKey, lpSubKey);
}

Referenced by CLangBarItemList::SaveItem(), CDefCompFrameWindow::SavePosition(), CTipbarWnd::SavePosition(), and TF_RegisterLangBarAddIn().

DeleteSubKey()

LSTATUS CicRegKey::DeleteSubKey ( LPCTSTR  lpSubKey )

inline

Definition at line 103 of file cicreg.h.

{
    return ::RegDeleteKey(m_hKey, lpSubKey);
}

Referenced by _cicRegKey_RecurseDeleteKey().

DeleteValue()

LSTATUS CicRegKey::DeleteValue ( LPCTSTR  pszValueName )

inline

Definition at line 98 of file cicreg.h.

{
    return ::RegDeleteValue(m_hKey, pszValueName);
}

Referenced by CLangBarItemList::SaveItem().

EnumValue()

LSTATUS CicRegKey::EnumValue ( DWORD  dwIndex, LPTSTR  lpValueName, DWORD  cchValueName  )

inline

Definition at line 108 of file cicreg.h.

{
    return _cicRegKey_EnumValue(*this, dwIndex, lpValueName, cchValueName);
}

Referenced by GetHKLSubstitute(), and InitSkipRedrawHKLArray().

Open()

LSTATUS CicRegKey::Open ( HKEY  hKey, LPCTSTR  lpSubKey, REGSAM  samDesired = KEY_READ  )

inline

Definition at line 51 of file cicreg.h.

{
    return _cicRegKey_Open(*this, hKey, lpSubKey, samDesired);
}

Referenced by _cicRegKey_RecurseDeleteKey(), CLangBarItemList::Clear(), DoCloseLangbar(), GetHKLSubstitute(), GetKbdLayoutNameFromReg(), GetSpecialKLID(), InitCUASFlag(), InitFromReg(), InitLangChangeHotKey(), InitSkipRedrawHKLArray(), IsDeskBandFromReg(), CLangBarItemList::Load(), CDefCompFrameWindow::LoadPosition(), TLS::NonEACompositionEnabled(), SetDeskBandToReg(), and TF_UnregisterLangBarAddIn().

operator HKEY()

CicRegKey::operator HKEY ( )

inline

Definition at line 18 of file cicreg.h.

{ return m_hKey; }

QueryDword()

LSTATUS CicRegKey::QueryDword ( LPCTSTR  pszValueName, LPDWORD  pdwValue  )

inline

Definition at line 61 of file cicreg.h.

{
    DWORD cbData = sizeof(DWORD);
    return ::RegQueryValueEx(m_hKey, pszValueName, 0, NULL, (LPBYTE)pdwValue, &cbData);
}

Referenced by InitCUASFlag(), InitFromReg(), IsDeskBandFromReg(), CLangBarItemList::Load(), CDefCompFrameWindow::LoadPosition(), and TLS::NonEACompositionEnabled().

QuerySz()

LSTATUS CicRegKey::QuerySz ( LPCTSTR  pszValueName, LPTSTR  pszValue, DWORD  cchValueMax  )

inline

Definition at line 84 of file cicreg.h.

{
    return _cicRegKey_QuerySz(*this, pszValueName, pszValue, cchValueMax);
}

Referenced by GetHKLSubstitute(), GetKbdLayoutNameFromReg(), GetSpecialKLID(), InitCUASFlag(), and InitLangChangeHotKey().

RecurseDeleteKey()

LSTATUS CicRegKey::RecurseDeleteKey ( LPCTSTR  lpSubKey )

inline

Definition at line 113 of file cicreg.h.

{
    return _cicRegKey_RecurseDeleteKey(*this, lpSubKey);
}

Referenced by _cicRegKey_RecurseDeleteKey(), CLangBarItemList::Clear(), CLangBarItemList::SaveItem(), and TF_UnregisterLangBarAddIn().

SetDword()

LSTATUS CicRegKey::SetDword ( LPCTSTR  pszValueName, DWORD  dwValue  )

inline

Definition at line 67 of file cicreg.h.

{
    return ::RegSetValueEx(m_hKey, pszValueName, 0, REG_DWORD, (LPBYTE)&dwValue, sizeof(dwValue));
}

Referenced by CLangBarItemList::SaveItem(), CDefCompFrameWindow::SavePosition(), CTipbarWnd::SavePosition(), SetDeskBandToReg(), and TF_RegisterLangBarAddIn().

SetSz()

LSTATUS CicRegKey::SetSz ( LPCTSTR  pszValueName, LPCTSTR  pszValue  )

inline

Definition at line 72 of file cicreg.h.

{
    DWORD cbValue = (lstrlen(pszValue) + 1) * sizeof(TCHAR);
    return ::RegSetValueEx(m_hKey, pszValueName, 0, REG_SZ, (LPBYTE)pszValue, cbValue);
}

SetSzW()

LSTATUS CicRegKey::SetSzW ( LPCWSTR  pszValueName, LPCWSTR  pszValue  )

inline

Definition at line 78 of file cicreg.h.

{
    DWORD cbValue = (lstrlenW(pszValue) + 1) * sizeof(WCHAR);
    return ::RegSetValueExW(m_hKey, pszValueName, 0, REG_SZ, (LPBYTE)pszValue, cbValue);
}

Referenced by TF_RegisterLangBarAddIn().

Member Data Documentation

m_hKey

HKEY CicRegKey::m_hKey

Definition at line 13 of file cicreg.h.

Referenced by _cicRegKey_Create(), _cicRegKey_EnumValue(), _cicRegKey_Open(), _cicRegKey_QuerySz(), _cicRegKey_RecurseDeleteKey(), Close(), DeleteSubKey(), DeleteValue(), operator HKEY(), QueryDword(), SetDword(), SetSz(), and SetSzW().

---

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

• sdk/lib/cicero/cicreg.h