SoapException.Detail Property

 

Gets an XmlNode that represents the application-specific error information details.

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

public XmlNode Detail { get; }

Property Value

Type: System.Xml.XmlNode

The application-specific error information.

The Detail property can be set using one of the class constructors that accepts a Detail value.

The Detail property is used to supply application-specific error details related to the Body element of the SOAP request. According to the SOAP specification, if an error occurs because the client request cannot be processed due to the Body element of the SOAP request, the Detail property must be set. If an error occurs in the header entries of the SOAP request, you must throw a SoapHeaderException, so that the error details are returned in the SOAP header. If the error does not occur, due to the processing of the Body element, then the Detail property must not be set.

In building an XmlNode for the Detail property, the Name and Namespace properties of DetailElementName can be used to ensure consistency with the SOAP specification.

All immediate child elements of the detail element are called detail entries and each detail entry is encoded as an independent element within the detail element.

The following example throws a SoapException, where the XML Web service method sets the Detail property.

.NET Framework
Available since 1.1
Return to top
Show: