TextReturnReader Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Use BaseTrue

Reads return values from HTTP response text for Web service clients implemented using HTTP but without SOAP.

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


[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class TextReturnReader : MimeReturnReader


Initializes a new instance of the TextReturnReader class.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Returns an initializer for the specified method.(Overrides MimeFormatter.GetInitializer(LogicalMethodInfo).)


When overridden in a derived class, returns an array of initializer objects corresponding to an input array of method definitions.(Inherited from MimeFormatter.)


Gets the Type of the current instance.(Inherited from Object.)


Initializes an instance.(Overrides MimeFormatter.Initialize(Object).)


Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRead(WebResponse, Stream)

Parses text contained in the HTTP response.(Overrides MimeReturnReader.Read(WebResponse, Stream).)


Returns a string that represents the current object.(Inherited from Object.)

TextReturnReader and other classes in the System.Web.Services.Protocols namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard.

The TextReturnReader class implements the client-side reading of non-XML text into Web method return values. To obtain a return value, the text, which is encoded in the body of an HTTP response, is parsed using regular expression pattern matching, as specified by the attribute MatchAttribute, which can be applied to a Web method in a client proxy class. The TextReturnReader class calls the PatternMatcher class to actually perform the pattern matching.

Text pattern matching provides a way for Web services to retrieve HTML content without converting it to XML documents that must be bound to XML Schema definitions. Regular expression search targets are specified in a Web Services Description Language (WSDL) document via match XML elements within text elements. Both elements belong to the namespace http://microsoft.com/wsdl/mime/textMatching/.

When match elements are specified in a WSDL document, the Wsdl.exe tool applies MatchAttribute attributes to the corresponding Web methods in the client proxy class that is generated. Also, TextReturnReader is used in place of XmlReturnReader, the default class for deserializing Web method return values according to the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations.

You typically will not need to use the TextReturnReader class directly.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top