SoapHeader.DidUnderstand Property


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

Gets or sets a value indicating whether an XML Web service method properly processed a SOAP header.

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

public bool DidUnderstand { get; set; }

Property Value

Type: System.Boolean

true if the SOAP header was properly processed; otherwise false.

For SOAP headers defined by an XML Web service, ASP.NET assumes the XML Web service method properly processed the SOAP header by setting the initial value of DidUnderstand to true. For SOAP headers not defined by the XML Web service, the initial value is false. If ASP.NET detects SOAP headers passed to an XML Web service method with DidUnderstand set to false after the method returns, a SoapHeaderException is thrown back to the XML Web service client instead of the results from the XML Web service method.

The following MyWebService XML Web service defines the MyHeader SOAP header and requires it to be sent with any calls to the MyWebMethod XML Web service method. Additionally, the MyWebMethod receives any SOAP headers other than the MyHeader SOAP header. For SOAP headers that MyWebMethod can process, DidUnderstand is set to true.

.NET Framework
Available since 1.1
Return to top