Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Socket::EndReceiveMessageFrom Method (IAsyncResult^, SocketFlags%, EndPoint^%, IPPacketInformation%)

 

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,
	SocketFlags% socketFlags,
	EndPoint^% endPoint,
	[OutAttribute] IPPacketInformation% ipPacketInformation
)

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:
© 2017 Microsoft