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

A Simple C# Global Low Level Keyboard Hook

Rate me:
Please Sign up or sign in to vote.
4.90/5 (98 votes)
30 May 2007CPOL2 min read 966.1K   68.1K   171   187
A simple description and sample of creating a global low level keyboard hook in C#
Screenshot - key_preview.jpg

Introduction

This article discusses a class that I wrote that wraps a global low level keyboard hook. The sample hooks the A and B keys, just for demonstration.

Background

I was trying to find a way for an application that I am writing to restore itself when a combination of keys was pressed. This was born from searching around for the answer.

Using the Code

First download the source, and add globalKeyboardHook.cs to your project. Then add...

C#
using Utilities;

... to the top of the file you are going to use it in. Next add an instance of globalKeyboardHook to your class:

C#
globalKeyboardHook gkh = new globalKeyboardHook() ;

When a globalKeyboardHook is constructed, it automatically installs the hook, so all there is left to do is add some keys for it to watch, and define some event handlers for the KeyDown and KeyUp events. I usually do this on the main form's load event handler, like this:

C#
private void Form1_Load(object sender, EventArgs e) {
    gkh.HookedKeys.Add(Keys.A);
    gkh.HookedKeys.Add(Keys.B);
    gkh.KeyDown += new KeyEventHandler(gkh_KeyDown);
    gkh.KeyUp += new KeyEventHandler(gkh_KeyUp);
} 

void gkh_KeyUp(object sender, KeyEventArgs e) {
    lstLog.Items.Add("Up\t" + e.KeyCode.ToString());
    e.Handled = true ;
}

void gkh_KeyDown(object sender, KeyEventArgs e) {
    lstLog.Items.Add("Down\t" + e.KeyCode.ToString());
    e.Handled = true ;
} 

Here I have chosen to watch for the A and B keys, and defined handlers for the KeyUp and KeyDown events that both log to a listbox called lstLog. So whenever the user presses the A or B keys, no matter what has focus, the application will be notified. Setting e.Handled to true makes it so no other notifications for this event go out, in the sample, this effectively stops the user from typing an A or B. This can be useful in ensuring that key combinations are not also typed out when used.

You can add hooks for as many keys as you would like, just add them like above. Don't get frustrated if you add a hook for a key and it doesn't work, many of them, like Keys.Shift show up as other more specific keys, like Keys.LShiftKey or Keys.RShiftKey. Keys.Alt shows up as Keys.LMenu or Keys.RMenu, Keys.Control shows up as Keys.LControl or Keys.RControl, just to name a few.

If you would like to hook or unhook the keyboard hook at any point, just call your globalKeyboardHook's hook and unhook methods, like so:

C#
//unhook
gkh.unhook() 
//set the hook again
gkh.hook() 

Points of Interest

The bulk of the work in this code is done in the globalKeyboardHook class, although it is a fairly simple piece of code itself. The hardest part of doing this was finding the correct parameters for SetWindowsHookEx.

C#
[DllImport("user32.dll")]
static extern IntPtr SetWindowsHookEx
    (int idHook, keyboardHookProc callback, IntPtr hInstance, uint threadId);

The parameters were worked out to be:

C#
IntPtr hInstance = LoadLibrary("User32");
hhook = SetWindowsHookEx(WH_KEYBOARD_LL, hookProc, hInstance, 0);

The first parameter WH_KEYBOARD_LL is just saying that we want to hook the low level keyboard events, hookProc is the callback for the event, hInstance is a handle to User32.dll, where this event is first processed (I think). The last parameter is if you want to hook a specific thread, then you would just pass a thread id instead of using the hInstance.

History

  • 5/30/07 - First version

License

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


Written By
Software Developer
United States United States
I currently work as a Software Engineer for a company in North Carolina, mainly working with C#.

Comments and Discussions

 
GeneralRe: A callback was made on a garbage collected delegate of type .... Pin
Member 1369185822-Feb-18 14:40
Member 1369185822-Feb-18 14:40 
GeneralRe: A callback was made on a garbage collected delegate of type .... Pin
Rooctor3-Jun-22 2:23
Rooctor3-Jun-22 2:23 
BugI need help Pin
Member 97217003-Jan-13 1:18
Member 97217003-Jan-13 1:18 
GeneralRe: I need help Pin
Jean Meyblum9-Jan-13 20:49
Jean Meyblum9-Jan-13 20:49 
GeneralThx for Nice Article Pin
iHUPPz Rwt7-Sep-12 8:26
iHUPPz Rwt7-Sep-12 8:26 
QuestionAnti Virus - Because of Set Windows Hook Pin
aces277-Sep-12 3:50
aces277-Sep-12 3:50 
AnswerRe: Anti Virus - Because of Set Windows Hook Pin
Eddy Vluggen4-Jun-14 11:11
professionalEddy Vluggen4-Jun-14 11:11 
Question32 Bit / 64 Bit Pin
aces277-Sep-12 3:47
aces277-Sep-12 3:47 
Please explain how this would behave for a 32 bit Windows system and a 64 bit system.
Will a build compiled in a 32 bit system work on a 64 bit machine and vice versa ?
Any other points to consider.
Questionhow to avoid repeated pressing of a key Pin
IgorBogomolov6-Sep-12 11:16
IgorBogomolov6-Sep-12 11:16 
AnswerRe: how to avoid repeated pressing of a key Pin
AnotherKen28-May-13 20:03
professionalAnotherKen28-May-13 20:03 
GeneralRe: how to avoid repeated pressing of a key Pin
irobot_22911-Aug-13 0:31
irobot_22911-Aug-13 0:31 
GeneralRe: how to avoid repeated pressing of a key Pin
AnotherKen11-Aug-13 8:08
professionalAnotherKen11-Aug-13 8:08 
GeneralMy vote of 5 Pin
IgorBogomolov6-Sep-12 11:13
IgorBogomolov6-Sep-12 11:13 
Bugnot stable Pin
Martype2.028-Aug-12 22:54
Martype2.028-Aug-12 22:54 
GeneralAdding Modifier Key Handling using GetKeyState Pin
jonegerton20-Aug-12 21:55
jonegerton20-Aug-12 21:55 
GeneralRe: Adding Modifier Key Handling using GetKeyState Pin
VSZM14-Apr-13 13:22
VSZM14-Apr-13 13:22 
GeneralRe: Adding Modifier Key Handling using GetKeyState Pin
Member 104003745-Mar-14 5:59
Member 104003745-Mar-14 5:59 
QuestionHow to hook combination of keys, not one by one ? Pin
NithrouS1-Aug-12 12:01
NithrouS1-Aug-12 12:01 
AnswerRe: How to hook combination of keys, not one by one ? Pin
AnotherKen26-May-13 16:19
professionalAnotherKen26-May-13 16:19 
GeneralMy vote of 4 Pin
Burak Tunçbilek27-Jul-12 10:06
Burak Tunçbilek27-Jul-12 10:06 
Suggestionsuggestion for improvement Pin
Christoph Strehle12-May-12 7:15
Christoph Strehle12-May-12 7:15 
Questionabout the Shift+A does not work Pin
lsh201113-Nov-11 21:07
lsh201113-Nov-11 21:07 
GeneralMy vote of 5 Pin
Adelino Araújo10-Nov-11 3:03
Adelino Araújo10-Nov-11 3:03 
GeneralMy vote of 5 Pin
mr_Prankster16-Aug-11 4:25
mr_Prankster16-Aug-11 4:25 
QuestionCan it run without the .NET framework Pin
aces2723-Jul-11 21:02
aces2723-Jul-11 21:02 

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.