SocketAsyncEventArgs.BufferList Property

Gets or sets an array of data buffers to use with an asynchronous socket method.

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

'Declaration
Public Property BufferList As IList(Of ArraySegment(Of Byte))

Property Value

Type: System.Collections.Generic.IList(Of ArraySegment(Of Byte))
An System.Collections.IList that represents an array of data buffers to use with an asynchronous socket method.

ExceptionCondition
ArgumentException

There are ambiguous buffers specified on a set operation. This exception occurs if the Buffer property has been set to a non-null value and an attempt was made to set the BufferList property to a non-null value.

This property is used with the Socket.ReceiveAsync and Socket.SendAsync methods.

This property is used to provide multiple buffers of data to be sent or to provide multiple buffers in which to store received data for an asynchronous socket operation that can send or receive data. Multiple buffers using the BufferList property are supported by the Socket.ReceiveAsync and Socket.SendAsync methods.

If the BufferList property is set to a non-null value, the Buffer property must be null and is ignored by the Socket.ReceiveAsync and Socket.SendAsync methods.

If the Buffer was set to a non-null value and an attempt is made to set the BufferList property to a non-null value, an exception is thrown.

If the BufferList property is set to a non-null value, the Socket.ConnectAsync and Socket.AcceptAsync methods will throw an ArgumentException.

The BufferList parameter is ignored by the Socket.DisconnectAsync and Socket.SendPacketsAsync methods.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1, 3.0 SP1, 2.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft