ISoapReader

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface, implemented by the SoapReader object, reads SOAP messages. The methods in this interface read the SOAP message and parse the message into a DOM. You can then retrieve the individual elements from the DOM.

The Calc sample application uses the ISoapReader interface. For more information, see SOAP Samples.

Various SoapReader properties make it easy to extract information out of the SOAP message without having to know the message's structure.

Note

While you can also retrieve information from a SOAP message using the Microsoft® XML Parser (MSXML) DOM API, the SoapReader properties make it easier to do the same thing.

The following tables show the methods and properties supported by ISoapReader interface.

Method Description

load Method (ISoapReader)

This method loads an XML document from a file, stream, or a URL.

loadXML Method (ISoapReader)

This method loads an XML document string provided as input.

Property Description

Body Property

This property returns the <Body> element of a SOAP message.

BodyEntries Property

This property returns a collection of entries in the <Body> element of a SOAP message.

BodyEntry Property

This property returns the first entry in the <Body> element of a SOAP message that matches the given local name and namespace URI.

DOM Property

This property provides a reference to the DOM document.

Envelope Property

This property returns the <Envelope> element in a SOAP message (thus, the entire SOAP message).

Fault Property (ISoapReader)

This property returns the <Fault> element in a SOAP message.

FaultActor Property (ISoapReader)

This property returns the <faultactor> element of the <Fault> element in the SOAP message.

FaultCode Property (ISoapReader)

This property returns the <faultcode> element of the <Fault> element in the SOAP message.

FaultDetail Property

This property returns the <detail> element of the <Fault> element in the SOAP message.

FaultString Property (ISoapReader)

This property returns the <faultstring> element of the <Fault> element in the SOAP message.

Header Property

This property returns the <Header> element in a SOAP message.

HeaderEntries Property

This property returns a collection of entries in the <Header> element of a SOAP message.

HeaderEntry Property

This property returns the first entry in the <Header> element of a SOAP message that matches the given local name and namespace URI.

MustUnderstandHeaderEntries Property

This property returns all entries from the <Header> element in a SOAP message that have a mustUnderstand attribute equal to 1.

RPCParameter Property

This property returns the first child element of the first entry within the <Body> element of a SOAP that matches the given local name and namespace URI.

RPCResult Property

This property returns the first child element of the first entry in the <Body> element of a SOAP message.

RPCStruct Property

This property returns the first entry in the <Body> element of a SOAP message.

soapAction Property (ISoapReader)

This property returns the "SOAPAction" HTTP header, if the input was a request object.

Requirements

Header mssoap.h
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

SOAP Objects and Interfaces