Export (0) Print
Expand All

NamedPipeServerStream.BeginWaitForConnection Method

Begins an asynchronous operation to wait for a client to connect.

Namespace:  System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public IAsyncResult BeginWaitForConnection(
	AsyncCallback callback,
	Object state
)

Parameters

callback
Type: System.AsyncCallback

The method to call when a client connects to the NamedPipeServerStream object.

state
Type: System.Object

A user-provided object that distinguishes this particular asynchronous request from other requests.

Return Value

Type: System.IAsyncResult
An object that references the asynchronous request.

ExceptionCondition
InvalidOperationException

The pipe was not opened asynchronously.

-or-

A pipe connection has already been established.

-or-

The pipe handle has not been set.

IOException

The pipe connection has been broken.

ObjectDisposedException

The pipe is closed.

This is the asynchronous equivalent of WaitForConnection.

EndWaitForConnection must be called exactly once for every call to BeginWaitForConnection.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft