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

WaitForSingleObject (kernel32)
 
.
Summary

C# Signature:

[DllImport("kernel32.dll", SetLastError=true)]
  static extern UInt32 WaitForSingleObject(IntPtr hHandle, UInt32 dwMilliseconds);

VB.NET Signature:

<DllImport("kernel32", SetLastError := True)> _
  Function WaitForSingleObject( _
    ByVal handle As IntPtr, _
    ByVal milliseconds As UInt32) As UInt32
  End Function

Boo Signature:

[DllImport("kernel32.dll")]
def WaitForSingleObject(hHandle as int, dwMilliseconds as long):
[DllImport("kernel32.dll", SetLastError : true)]
static def WaitForSingleObject(hHandle as IntPtr, dwMilliseconds as uint) as uint:
     pass

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

C#

  const UInt32 INFINITE = 0xFFFFFFFF;
  const UInt32 WAIT_ABANDONED = 0x00000080;
  const UInt32 WAIT_OBJECT_0 = 0x00000000;
  const UInt32 WAIT_TIMEOUT = 0x00000102;

  and use:

  WaitForSingleObject(handle, (int)INFINITE);

VB.NET

  Const INFINITE As UInt32 = &HFFFFFFFFUI
  Const WAIT_ABANDONED As UInt32 = &H80UI
  Const WAIT_OBJECT_0 As UInt32 = &H0UI
  Const WAIT_TIMEOUT As UInt32 = &H102UI

  and use:

  WaitForSingleObject(handle, INFINITE)

Sample Code:

private void Run()
{
  while (bRunning)
  {
   try
    {
     if(WaitForSingleObject(ReceivedEvent,INFINITE) == WAIT_OBJECT_0)
     {
      // Signaled            
      DoSomething();
     }
    }

    catch(Exception Ex)
    {
     // An exception occurred
     //
     trhow(Ex);
    }
   }
}

UInt32 waitFor;
waitFor = WaitForSingleObject(hMutex, 10000);
if (waitFor == WAIT_TIMEOUT)
     throw new ....
else if (waitFor == WAIT_ABANDONED)
{
     ReleaseMutex(waitFor);
     throw new ....
}
if (waitFor != WAIT_OBJECT_0)
{
     throw new Win32Exception("Synchronization Mutex Error.");
}
return 0;

Alternative Managed API:

If you have a System.Diagnostic.Process object (possibly created by Process.Start), call Process.WaitForExit().

If you're waiting on a file system object, look at System.IO.FileSystemWatcher

System.Threading.WaitHandle and derivatives (e.g. AutoResetEvent)

System.Threading.Timeout.Infinite

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