SoapUnknownHeader.Element Property
Gets or sets the XML Header element for a SOAP request or response.
[Visual Basic] Public Property Element As XmlElement [C#] public XmlElement Element {get; set;} [C++] public: __property XmlElement* get_Element(); public: __property void set_Element(XmlElement*); [JScript] public function get Element() : XmlElement; public function set Element(XmlElement);
Property Value
An XmlElement representing the raw XML of the SOAP header.
Remarks
If an XML Web service method wants to process SOAP headers it does not know about at the time the XML Web service is written, it can process an XmlElement class representing the raw XML of the SOAP header.
Example
[Visual Basic, C#] The following MyWebService XML Web service receives all SOAP headers, including ones other than the MyHeader SOAP header it knows about. The MyWebMethod XML Web service method returns to the client the XML attributes of the last unknown SOAP header passed to it as a string.
[Visual Basic] <%@ WebService Language="VB" Class="MyWebService"%> Imports System.Web.Services Imports System.Web.Services.Protocols Imports System.Xml Imports System ' Define a SOAP header by deriving from the SoapHeader base class. Public Class MyHeader Inherits SoapHeader Public MyValue As String End Class Public Class MyWebService Public myHeader As MyHeader ' Receive all SOAP headers besides the MyHeader SOAP header. Public unknownHeaders() As SoapUnknownHeader 'Receive any SOAP headers other than MyHeader. <WebMethod, _ SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut), _ SoapHeader("unknownHeaders")> _ Public Function MyWebMethod() As String Dim unknownHeaderAttributes As String = String.Empty ' Set myHeader.MyValue to some value. Dim header As SoapUnknownHeader For Each header In unknownHeaders ' Perform some processing on the header. Dim attribute As XmlAttribute For Each attribute In header.Element.Attributes unknownHeaderAttributes &= attribute.Name & ":" & _ attribute.Value & ";" Next attribute ' For those headers that cannot be ' processed, set the DidUnderstand property to false. header.DidUnderstand = False Next header Return unknownHeaderAttributes End Function End Class [C#] <%@ WebService Language="C#" Class="MyWebService"%> using System.Web.Services; using System.Web.Services.Protocols; using System.Xml; using System; // Define a SOAP header by deriving from the SoapHeader base class. public class MyHeader : SoapHeader { public string MyValue; } public class MyWebService { public MyHeader myHeader; // Receive all SOAP headers besides the MyHeader SOAP header. public SoapUnknownHeader[] unknownHeaders; [WebMethod] [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)] //Receive any SOAP headers other than MyHeader. [SoapHeader("unknownHeaders")] public string MyWebMethod() { string unknownHeaderAttributes = String.Empty; // Set myHeader.MyValue to some value. foreach (SoapUnknownHeader header in unknownHeaders) { // Perform some processing on the header. foreach (XmlAttribute attribute in header.Element.Attributes) { unknownHeaderAttributes = unknownHeaderAttributes + attribute.Name + ":" + attribute.Value + ";"; } // For those headers that cannot be // processed, set the DidUnderstand property to false. header.DidUnderstand = false; } return unknownHeaderAttributes; } }
[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework
See Also
SoapUnknownHeader Class | SoapUnknownHeader Members | System.Web.Services.Protocols Namespace | XmlElement | SoapHeaderAttribute