WebMethodAttribute.BufferResponse Property

 

Gets or sets whether the response for this request is buffered.

Namespace:   System.Web.Services
Assembly:  System.Web.Services (in System.Web.Services.dll)

public bool BufferResponse { get; set; }

Property Value

Type: System.Boolean

true if the response for this request is buffered; otherwise, false. The default is true.

Setting BufferResponse to true, serializes the response of the XML Web service method into a memory buffer until either the response is completely serialized or the buffer is full. Once the response is buffered, it is returned to the XML Web service client over the network. When BufferResponse is false, the response to the XML Web service method is sent back to the client as it is serialized. In general, you only want to set BufferResponse to false, if it is known that an XML Web service method returns large amounts of data to the client. For smaller amounts of data, XML Web service performance is better with BufferResponse to true.

When BufferResponse is false, SOAP extensions are disabled for the XML Web service method.

The following code example sets the BufferResponse property to false and handles the streaming of a text file back to the client. The code example demonstrates how to stream a large piece of data back to the client using a class that implements the IEnumerable interface.

.NET Framework
Available since 1.1
Return to top
Show: