Click here to Skip to main content
15,867,568 members
Articles / Programming Languages / C#
Article

RegistryMonitor - a .NET wrapper class for RegNotifyChangeKeyValue

Rate me:
Please Sign up or sign in to vote.
4.96/5 (46 votes)
16 Jan 2006CPOL2 min read 340.4K   12.7K   111   92
The Windows API provides a function RegNotifyChangeKeyValue, which is not covered by the Microsoft.Win32.RegistryKey class. This solution imports that function and encapsulates it in a convenient manner.

Sample Image - RegistryMonitor.png

Introduction

The Windows API provides a function RegNotifyChangeKeyValue, which notifies the caller about changes to attributes or the content of a specified registry key. Unfortunately, this function is not provided by the Microsoft.Win32.RegistryKey class. Because I needed that functionality, I've written a simple wrapper class.

Usage

Instantiation

RegistryMonitor has three constructors, the parameter lists should be self-explanatory:

C#
RegistryMonitor(RegistryKey registryKey)
RegistryMonitor(string name)
RegistryMonitor(RegistryHive registryHive, string subKey)

Events

RegistryMonitor supports two events:

C#
public event EventHandler RegChanged;
public event ErrorEventHandler Error;

The RegChanged event is raised when the registry key specified during construction has changed. Error is raised when an exception occurs.

The latter event is necessary because the monitoring is hosted in a different thread.

Properties

RegistryMonitor has only one property:

C#
public RegChangeNotifyFilter RegChangeNotifyFilter { get; set; }

RegChangeNotifyFilter is an enum. Since I don't want to repeat its implementation here in the article, I just want to say that it controls which kinds of registry changes will be detected, e.g. only key or value changes.

Methods

RegistryMonitor has two public methods which are declared as follows:

C#
public void Start();
public void Stop();

I don't think that these methods require much explanation. The former creates a separate thread, which will monitor the registry, and the latter will stop that thread.

Example

Because a simple example will say more than a thousand words, here's a console sample monitoring HKCU\Environment (that's where the current user's environment variables are stored):

C#
public class MonitorSample
{
    static void Main() 
    {
        RegistryMonitor monitor = new 
          RegistryMonitor(RegistryHive.CurrentUser, "Environment");
        monitor.RegChanged += new EventHandler(OnRegChanged);
        monitor.Start();
 
        while(true);
        
        monitor.Stop();
    }
         
    private void OnRegChanged(object sender, EventArgs e)
    {
        Console.WriteLine("registry key has changed");
    }
}

Provided with this article is another demo, which is a WinForms application (however, a VS.NET 2003 solution).

Points of interest

The first version of RegistryMonitor used reflection to retrieve the private hkey field of the Microsoft.Win32.RegistryKey class. However, Microsoft changed the internal implementation, so this hack didn't work anymore (see the comments below). Therefore I changed my implementation, so that RegistryMonitor now uses P/Invoke to open and close the registry key explicitly.

History

  • 08-Jul-2003 - Initial release.
  • 15-Jan-2005 - Updated to work for both .NET 1.1 and 2.0.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer Cloud Klabauter GmbH
Germany Germany
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
NewsRe: 3ks a lot Pin
Thomas Freudenberg20-Dec-05 22:37
Thomas Freudenberg20-Dec-05 22:37 
GeneralThank you for the article!! Pin
Eric Seipp12-Nov-05 13:36
Eric Seipp12-Nov-05 13:36 
QuestionChanges made? Pin
stcain18-Nov-04 2:09
stcain18-Nov-04 2:09 
GeneralCPU Pin
hunterb16-Nov-04 16:19
hunterb16-Nov-04 16:19 
GeneralRe: CPU Pin
Thomas Freudenberg16-Nov-04 20:46
Thomas Freudenberg16-Nov-04 20:46 
GeneralRe: CPU Pin
hunterb17-Nov-04 2:31
hunterb17-Nov-04 2:31 
GeneralRe: CPU Pin
Thomas Freudenberg17-Nov-04 3:10
Thomas Freudenberg17-Nov-04 3:10 
GeneralRe: CPU Pin
Anonymous5-Jan-05 6:21
Anonymous5-Jan-05 6:21 
a
while (Console.Read() != 'q');

could fix this problem Wink | ;-)

greets

O.M.
GeneralRe: CPU Pin
Thomas Freudenberg5-Jan-05 7:03
Thomas Freudenberg5-Jan-05 7:03 
GeneralRe: CPU Pin
Trance Junkie17-Jan-06 0:28
Trance Junkie17-Jan-06 0:28 
GeneralRe: CPU Pin
thapa da man27-Jun-06 1:20
thapa da man27-Jun-06 1:20 
GeneralSuggestion Pin
Joe Woodbury8-Sep-04 8:51
professionalJoe Woodbury8-Sep-04 8:51 
GeneralRe: Suggestion Pin
Thomas Freudenberg8-Sep-04 21:29
Thomas Freudenberg8-Sep-04 21:29 
GeneralRegistry infos Pin
jocool25506-Aug-04 3:28
jocool25506-Aug-04 3:28 
GeneralRe: Registry infos Pin
Thomas Freudenberg6-Aug-04 4:02
Thomas Freudenberg6-Aug-04 4:02 
GeneralRe: Registry infos Pin
jocool25506-Aug-04 4:20
jocool25506-Aug-04 4:20 

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.