Export (0) Print
Expand All

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.

<%@WebService class="Streaming" language="C#"%>

using System;
using System.IO;
using System.Collections;
using System.Xml.Serialization;
using System.Web.Services;
using System.Web.Services.Protocols;

public class Streaming {

    public TextFile GetTextFile(string filename) {
        return new TextFile(filename);

    public void CreateTextFile(TextFile contents) {


public class TextFile {
    public string filename;
    private TextFileReaderWriter readerWriter;

    public TextFile() {

    public TextFile(string filename) {
        this.filename = filename;

    public TextFileReaderWriter contents {
        get {
            readerWriter = new TextFileReaderWriter(filename);
            return readerWriter;

    public void Close() {
        if (readerWriter != null) readerWriter.Close();

public class TextFileReaderWriter : IEnumerable {

    public string Filename;
    private StreamWriter writer;

    public TextFileReaderWriter() {

    public TextFileReaderWriter(string filename) {
        Filename = filename;

    public TextFileEnumerator GetEnumerator() {
        StreamReader reader = new StreamReader(Filename);
        return new TextFileEnumerator(reader);

    IEnumerator IEnumerable.GetEnumerator() {
        return GetEnumerator();

    public void Add(string line) {
        if (writer == null)
            writer = new StreamWriter(Filename);

    public void Close() {
        if (writer != null) writer.Close();


public class TextFileEnumerator : IEnumerator {
    private string currentLine;
    private StreamReader reader;

    public TextFileEnumerator(StreamReader reader) {
        this.reader = reader;

    public bool MoveNext() {
        currentLine = reader.ReadLine();
        if (currentLine == null) {
            return false;
            return true;

    public void Reset() {
        reader.BaseStream.Position = 0;

    public string Current {
        get {
            return currentLine;

    object IEnumerator.Current {
        get {
            return Current;

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
© 2015 Microsoft