Click here to Skip to main content
15,867,141 members
Articles / Desktop Programming / MFC
Article

A Registry Class

Rate me:
Please Sign up or sign in to vote.
4.54/5 (28 votes)
6 Aug 20012 min read 211.6K   2.7K   55   48
A class that makes it easy to work with the registry

Overview

I created this class to make it easy to work with the Registry. For this I created the CRegistry class.

The CRegistry Class

The CRegistry class has a set of functions that make using the registry easy.

CRegistry::OpenKey

The OpenKey opens the specified registry key.

BOOL OpenKey(enum Keys hKey, LPCTSTR szKey);

Parameters

enum Keys hKey - Handle to any of the following predefined values:

CRegistry::classesRoot

CRegistry::currentUser

CRegistry::localMachine

CRegistry::currentConfig

CRegistry::users

Windows NT/2000: CRegistry::performanceData

Windows 95/98: CRegistry::dynData

LPCTSTR szKey - Pointer to a null-terminated string containing the name of the key to open.

If the function succeeds, this returns TRUE.

See sample

<a name="Sample1">
  CRegistry pReg;
  
  pReg.OpenKey(CRegistry::currentUser, "Entry1\\carlos1");
  CString str = _T("");

  if(pReg.GetValue("SZVAL1", str))
    AfxMessageBox("The Value SZVAL1 don't exists", MB_ICONWARNING);
    
  DWORD dwVal = 0;
  pReg.GetValue("DWVAL", dwVal);

  pReg.GetValue(NULL, str);
  pReg.CloseKey();</a>

CRegistry::CreateKey

The CreateKey function creates the specified registry key. If the key already exists in the registry, the function opens it.

BOOL CreateKey(enum Keys hKey, LPCTSTR szKey);

Parameters

enum Keys hKey - Handle to any of the following predefined values:

CRegistry::classesRoot

CRegistry::currentUser

CRegistry::localMachine

CRegistry::currentConfig

CRegistry::users

Windows NT/2000: CRegistry::performanceData

Windows 95/98: CRegistry::dynData

LPCTSTR szKey - Pointer to a null-terminated string containing the name of the key to open or create.

If the function succeeds, this returns TRUE.

CRegistry::DeleteKey

The DeleteKey function deletes a subkey.

BOOL DeleteKey(enum Keys hKey, LPCTSTR szKey);

Parameters

enum Keys hKey - Handle to any of the following predefined values:

CRegistry::classesRoot

CRegistry::currentUser

CRegistry::localMachine

CRegistry::currentConfig

CRegistry::users

Windows NT/2000: CRegistry::performanceData

Windows 95/98: CRegistry::dynData

LPCTSTR szKey - Pointer to a null-terminated string containing the name of the key to delete.

If the function succeeds, this returns TRUE.

CRegistry::GetValue

The GetValue function retrieves the data for a specified value name from the open registry key.

BOOL GetValue(LPCTSTR lpValueName, CString& strValue);
BOOL GetValue(LPCTSTR lpValueName, DWORD& dwValue);

Parameters

LPCTSTR lpValueName - Pointer to a null-terminated string containing the name of the value to get

CString& strValue - Pointer to a buffer that receives the value's data

DWORD& dwValue - Pointer to a buffer that receives the value's data

If the function succeeds, this returns TRUE.

See sample

CRegistry::SetValue

The SetValue function sets the data and type of a specified value under a registry key.

BOOL SetValue(LPCTSTR lpValueName, LPCTSTR lpData);
BOOL SetValue(LPCTSTR lpValueName, DWORD dwValue);

Parameters

LPCTSTR lpValueName - Pointer to a null-terminated string containing the name of the value to set

CString& strValue - Pointer to a buffer containing the data to be stored with the specified value name

DWORD& dwValue - Pointer to a buffer containing the data to be stored with the specified value name

If the function succeeds, this returns TRUE.

See sample

<a name="Sample2">pReg.OpenKey(CRegistry::currentUser, "Entry1\\carlos1");

pReg.SetValue("SZVAL", "STRVAL");
pReg.SetValue(NULL, "default");
pReg.SetValue("DWVAL", 34); 

pReg.CloseKey();</a>

CRegistry::DeleteValue

The DeleteValue function removes a named value from the specified registry key

BOOL DeleteValue(LPCTSTR lpValueName);

Parameters

LPCTSTR lpValueName - Pointer to a null-terminated string that names the value to remove.

If the function succeeds, this returns TRUE.

See sample

<a name="Sample3">  CRegistry pReg;

  pReg.OpenKey(CRegistry::currentUser, "Entry1\\carlos1");

  pReg.DeleteValue("SZVAL");	
  pReg.CloseKey();</a>

CRegistry::CloseKey

The CloseKey function closes the registry key.

void CloseKey();

See sample

Updates

04 August 2001: Version 1.0 Released.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Architect Citigroup
Argentina Argentina
Carlos Antollini is a software engineer working on Object Oriented, Visual C++, MFC, COM, ATL, ADO, Internet technologies and Business Intelligence.
Carlos is originally from Argentina, he was living for several years in Fort Lauderdale, Florida, working for Citibank. Then he started his own business.
Carlos is the creator of <a href="http://www.piFive.com">piFive</a>[<a target="_blank" title="piFive" href="http://www.piFive.com">^</a>], a family of BI Analytic Platform software, that it deals next to, <a href="http://www.latinsys.com">latinsys</a>[<a target="_blank" title="latinsys" href="http://www.latinsys.com">^</a>], his partner in businesses...
Currently he is sharing his passion for project management and BI at Citigroup.

Comments and Discussions

 
BugIn function CRegistry::GetValue(LPCTSTR lpValueName, DWORD& dwValue) 64-bit pointer truncation Pin
User 269428-Apr-15 3:05
professionalUser 269428-Apr-15 3:05 
BugErrors compiling UNICODE version with VS2010 Pin
User 2694230-Oct-13 1:51
professionalUser 2694230-Oct-13 1:51 
BugOpenKey does not work on Windows 7 Pin
Thomas Haase27-Sep-11 23:32
Thomas Haase27-Sep-11 23:32 
GeneralCannot read key from class Registry Pin
Larry Mills Sr3-Jun-09 15:39
Larry Mills Sr3-Jun-09 15:39 
Questionvery useful class Pin
kryptun16-Dec-08 10:50
kryptun16-Dec-08 10:50 
Questionerror C2872: 'ULONG_PTR' : ambiguous symbol Pin
Pooh Agarwal17-Oct-06 20:50
Pooh Agarwal17-Oct-06 20:50 
AnswerRe: error C2872: 'ULONG_PTR' : ambiguous symbol Pin
Vider22-Nov-07 3:33
Vider22-Nov-07 3:33 
Generalbug fix for VC7/8 [modified] Pin
Waldermort4-Oct-06 8:16
Waldermort4-Oct-06 8:16 
GeneralThank you Pin
msanchezv30-Jan-06 1:25
msanchezv30-Jan-06 1:25 
GeneralMemory leak Pin
jmaccelari19-Jul-04 20:45
jmaccelari19-Jul-04 20:45 
Generalcan't get it to work (noob!) Pin
E-Male19-May-04 0:13
E-Male19-May-04 0:13 
GeneralAlmost perfect! Pin
Terry O'Nolley15-May-04 15:23
Terry O'Nolley15-May-04 15:23 
GeneralRe: Almost perfect! Pin
Carlos Antollini15-May-04 15:42
Carlos Antollini15-May-04 15:42 
Questionbug with 2000pro ? Pin
alex-pcom22-Jan-04 2:17
alex-pcom22-Jan-04 2:17 
AnswerRe: bug with 2000pro ? Pin
Carlos Antollini22-Jan-04 3:36
Carlos Antollini22-Jan-04 3:36 
GeneralRe: bug with 2000pro ? Pin
Shikamaru27-Apr-04 21:03
Shikamaru27-Apr-04 21:03 
GeneralSource updated for VS7 Pin
ralfoide30-Sep-03 11:42
ralfoide30-Sep-03 11:42 
QuestionShould RegFlushKey be used? Pin
Baz18-Jul-03 4:53
Baz18-Jul-03 4:53 
GeneralVC7 compiler errors/warnings Pin
User 2694223-Jan-03 3:17
professionalUser 2694223-Jan-03 3:17 
GeneralEnumKey Pin
Michael Ehehalt8-Dec-02 19:41
Michael Ehehalt8-Dec-02 19:41 
GeneralRe: EnumKey Pin
Bruno Scopigno4-Jan-07 12:31
Bruno Scopigno4-Jan-07 12:31 
Generalbug in GetValue Pin
Michael Ehehalt8-Dec-02 19:31
Michael Ehehalt8-Dec-02 19:31 
Generalbug in the readstring Pin
User 98851-Oct-02 14:08
User 98851-Oct-02 14:08 
GeneralProblem with Hkey local machine Pin
zvivered18-Aug-02 6:11
zvivered18-Aug-02 6:11 
GeneralRe: Problem with Hkey local machine Pin
Raimon814-Nov-05 2:34
Raimon814-Nov-05 2:34 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.