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
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
shutdownblockreasoncreate (user32)
 
.
Summary
Indicates that the system cannot be shut down and sets a reason string to be displayed to the user if system shutdown is initiated.

C# Signature:

[DllImport("user32.dll", SetLastError=true)]
static extern bool ShutdownBlockReasonCreate(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] string reason);

VB Signature:

Declare Function ShutdownBlockReasonCreate Lib "user32.dll" (hWnd as IntPtr, reason As String) As Boolean

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Parameters:

hWnd - A handle to the main window of the application.

reason - The reason the application must block system shutdown.

Tips & Tricks:

  • Invisible windows won't show up in Vista's "Running Applications" dialog on shutdown/logoff and therefore the reason set with this method will not be visible to the end-user .
  • Make sure you also block/delay the WM_QUERYENDSESSION message.

Sample Code:

IntPtr handleForShutdownBlocker = shutdownBlockingForm.Handle;
if (!ShutdownBlockReasonCreate(handleForShutdownBlocker, UIMessages.GetString("ShutdownBlockReason"))) {
    // failed, log error code and handle used.
    int error = Marshal.GetLastWin32Error();
    log.Error(string.Format("Failed calling ShutdownBlockReasonCreate. Error code: {0}, blocking form handle: {1}", error, handleForShutdownBlocker));
}

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