Begins to asynchronously receive data from a connected Socket.
This API is not CLS-compliant.
Namespace:
System.Net.Sockets
Assembly:
System (in System.dll)
Visual Basic (Declaration)
<CLSCompliantAttribute(False)> _
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Function BeginReceive ( _
buffers As IList(Of ArraySegment(Of Byte)), _
socketFlags As SocketFlags, _
callback As AsyncCallback, _
state As Object _
) As IAsyncResult
Dim instance As Socket
Dim buffers As IList(Of ArraySegment(Of Byte))
Dim socketFlags As SocketFlags
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginReceive(buffers, _
socketFlags, callback, state)
[CLSCompliantAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public IAsyncResult BeginReceive(
IList<ArraySegment<byte>> buffers,
SocketFlags socketFlags,
AsyncCallback callback,
Object state
)
[CLSCompliantAttribute(false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
IAsyncResult^ BeginReceive(
IList<ArraySegment<unsigned char>>^ buffers,
SocketFlags socketFlags,
AsyncCallback^ callback,
Object^ state
)
public function BeginReceive(
buffers : IList<ArraySegment<byte>>,
socketFlags : SocketFlags,
callback : AsyncCallback,
state : Object
) : IAsyncResult
The asynchronous BeginReceive operation must be completed by calling the EndReceive method. Typically, the method is invoked by the callback delegate.
This method does not block until the operation is complete. To block until the operation is complete, use one of the Receive method overloads.
To cancel a pending BeginReceive, call the Close method.
For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously.
Note: |
|---|
If you receive a SocketException, use the SocketException..::.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error. |
Note: |
|---|
All I/O initiated by a given thread is canceled when that thread exits. A pending asynchronous operation can fail if the thread exits before the operation completes. |
Note: |
|---|
state is an instantiation of a user-defined class. |
Note: |
|---|
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing. |
Note: |
|---|
The execution context (the security context, the impersonated user, and the calling context) is cached for the asynchronous Socket methods. After the first use of a particular context (a specific asynchronous Socket method, a specific Socket instance, and a specific callback), subsequent uses of that context will see a performance improvement. |
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference
Other Resources