This documentation is archived and is not being maintained.

Socket.BeginReceiveMessageFrom Method

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

Begins to asynchronously receive the specified number of bytes of data into the specified location of the data buffer, using the specified SocketFlags, and stores the endpoint and packet information..

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

public IAsyncResult BeginReceiveMessageFrom (
	byte[] buffer,
	int offset,
	int size,
	SocketFlags socketFlags,
	ref EndPoint remoteEP,
	AsyncCallback callback,
	Object state
)
public IAsyncResult BeginReceiveMessageFrom (
	byte[] buffer, 
	int offset, 
	int size, 
	SocketFlags socketFlags, 
	/** @ref */ EndPoint remoteEP, 
	AsyncCallback callback, 
	Object state
)
JScript does not support passing value-type arguments by reference.

Parameters

buffer

An array of type Byte that is the storage location for the received data.

offset

The zero-based position in the buffer parameter at which to store the data.

size

The number of bytes to receive.

socketFlags

A bitwise combination of the SocketFlags values.

remoteEP

An EndPoint that represents the source of the data.

callback

The AsyncCallback delegate.

state

An object that contains state information for this request.

Return Value

An IAsyncResult that references the asynchronous read.

Exception typeCondition

ArgumentNullException

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

-or-

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

SocketException

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

ArgumentOutOfRangeException

offset is less than 0.

-or-

offset is greater than the length of buffer.

-or-

size is less than 0.

-or-

size is greater than the length of buffer minus the value of the offset parameter.

ObjectDisposedException

The Socket has been closed.

NotSupportedException

The operating system is Windows 2000 or earlier, and this method requires Windows XP.

The asynchronous receive operation must be completed by calling the EndReceiveMessageFrom method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block until the operation completes. To block until the operation completes, use the ReceiveMessageFrom method.

To cancel a pending BeginReceiveMessageFrom, call the Close method.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

This method reads data into the buffer parameter, and captures the remote host endpoint from which the data is sent, as well as information about the received packet. For information on how to retrieve this endpoint, refer to EndReceiveFrom. This method is most useful if you intend to asynchronously receive connectionless datagrams from an unknown host or multiple hosts.

NoteNote

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.

NoteNote

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

NoteNote

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 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
Show: