This documentation is archived and is not being maintained.

Socket.EndReceiveMessageFrom Method

Note: This method is new in the .NET Framework version 2.0.

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)

public int EndReceiveMessageFrom (
	IAsyncResult asyncResult,
	ref SocketFlags socketFlags,
	ref EndPoint endPoint,
	out IPPacketInformation ipPacketInformation
public int EndReceiveMessageFrom (
	IAsyncResult asyncResult, 
	/** @ref */ SocketFlags socketFlags, 
	/** @ref */ EndPoint endPoint, 
	/** @attribute OutAttribute() */ /** @ref */ IPPacketInformation ipPacketInformation
JScript does not support passing value-type arguments by reference.



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


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


The source EndPoint.


The IPAddress and interface of the received packet.

Return Value

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

Exception typeCondition


asyncResult is a null reference (Nothing in Visual Basic)


endPoint is a null reference (Nothing in Visual Basic).


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


EndReceiveMessageFrom was previously called for the asynchronous read.


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


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.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0