Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

SetConsoleCtrlHandler (kernel32)
 
.
Summary

C# Signature:

[DllImport("kernel32.dll")]
static extern bool SetConsoleCtrlHandler(ConsoleCtrlDelegate HandlerRoutine,
   bool Add);

C# User-Defined Types:

User-Defined Types:

// Delegate type to be used as the Handler Routine for SCCH
delegate Boolean ConsoleCtrlDelegate(CtrlTypes CtrlType);

// Enumerated type for the control messages sent to the handler routine
enum CtrlTypes : uint {
    CTRL_C_EVENT = 0,
    CTRL_BREAK_EVENT,
    CTRL_CLOSE_EVENT,  
    CTRL_LOGOFF_EVENT = 5,
    CTRL_SHUTDOWN_EVENT
}

VB.NET Signature:

Private Declare Function SetConsoleCtrlHandler Lib "kernel32" (Handler As ConsoleCtrlDelegate, Add As Boolean) As Boolean

VB.NET User-Defined Types:

Private Enum CtrlTypes As UInteger
   CTRL_C_EVENT = 0
   CTRL_BREAK_EVENT
   CTRL_CLOSE_EVENT
   CTRL_LOGOFF_EVENT = 5
   CTRL_SHUTDOWN_EVENT
End Enum

Private Delegate Function ConsoleCtrlDelegate(CtrlType As CtrlTypes) As Boolean

Notes:

None.

Tips & Tricks:

Please add some!

Alternative Managed API:

Do you know one? Please contribute it!

Sample Code:

Nice example on MSDN in KeepAlive method description:

http://msdn.microsoft.com/library/en-us/cpref/html/frlrfSystemGCClassKeepAliveTopic.asp

Documentation

Alternative Managed API:

Do you know one? Please contribute it!

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions