Stream.CreateWaitHandle Method

NOTE: This method is now obsolete.

Allocates a WaitHandle object.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

<ObsoleteAttribute("CreateWaitHandle will be removed eventually.  Please use " & ChrW(34) & "new ManualResetEvent(false)" & ChrW(34) & " instead.")> _
Protected Overridable Function CreateWaitHandle As WaitHandle
Dim returnValue As WaitHandle

returnValue = Me.CreateWaitHandle
/** @attribute ObsoleteAttribute("CreateWaitHandle will be removed eventually.  Please use \"new ManualResetEvent(false)\" instead.") */ 
protected WaitHandle CreateWaitHandle ()
ObsoleteAttribute("CreateWaitHandle will be removed eventually.  Please use \u0022new ManualResetEvent(false)\u0022 instead.") 
protected function CreateWaitHandle () : WaitHandle
Not applicable.

Return Value

A reference to the allocated WaitHandle.

For an example of creating a file and writing text to a file, see Writing Text to a File. For an example of reading text from a file, see Reading Text from a File. For an example of reading from and writing to a binary file, see Reading and Writing to a Newly Created Data File.

When called for the first time, the current method creates a WaitHandle object and returns it. On subsequent calls, CreateWaitHandle returns a reference to a new wait handle.

Use this method if you implement the asynchronous methods and require a way of blocking in EndRead or EndWrite until the asynchronous operation is complete.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 1.0, 1.1, 2.0
Obsolete (compiler warning) in 3.0

.NET Compact Framework

Supported in: 1.0
Obsolete (compiler warning) in 2.0

XNA Framework

Supported in: 1.0

Community Additions