Socket.EndReceiveMessageFrom Method (IAsyncResult, SocketFlags, EndPoint, IPPacketInformation)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Ends a pending asynchronous read from a specific endpoint. This method also reveals more information about the packet than EndReceiveFrom.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

member EndReceiveMessageFrom : 
        asyncResult:IAsyncResult *
        socketFlags:SocketFlags byref *
        endPoint:EndPoint byref *
        ipPacketInformation:IPPacketInformation byref -> int

Parameters

asyncResult
Type: System.IAsyncResult

An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

socketFlags
Type: System.Net.Sockets.SocketFlags

A bitwise combination of the SocketFlags values for the received packet.

endPoint
Type: System.Net.EndPoint

The source EndPoint.

ipPacketInformation
Type: System.Net.Sockets.IPPacketInformation

The IPAddress and interface of the received packet.

Return Value

Type: System.Int32

If successful, the number of bytes received. If unsuccessful, returns 0.

Exception Condition
ArgumentNullException

asyncResult is null

-or-

endPoint is null.

ArgumentException

asyncResult was not returned by a call to the BeginReceiveMessageFrom method.

InvalidOperationException

EndReceiveMessageFrom was previously called for the asynchronous read.

SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

If the operation has not completed, this method blocks until it does.

To perform this operation synchronously, use the ReceiveMessageFrom method.

Examine ipPacketInformation if you need to know if the datagram was sent using a unicast, multicast, or broadcast address.

.NET Framework
Available since 2.0
Return to top
Show: