SoapUnknownHeader Class
Represents the data received from a SOAP header that was not understood by the recipient XML Web service or XML Web service client. This class cannot be inherited.
For a list of all members of this type, see SoapUnknownHeader Members.
System.Object
System.Web.Services.Protocols.SoapHeader
System.Web.Services.Protocols.SoapUnknownHeader
[Visual Basic] NotInheritable Public Class SoapUnknownHeader Inherits SoapHeader [C#] public sealed class SoapUnknownHeader : SoapHeader [C++] public __gc __sealed class SoapUnknownHeader : public SoapHeader [JScript] public class SoapUnknownHeader extends SoapHeader
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Remarks
A SOAP client might invoke an XML Web service with additional data beyond the required parameters in the form of a SOAP header. An XML Web service created using ASP.NET or an XML Web service client can view any SOAP headers it did not know about at the time the XML Web service was written by applying a SoapHeaderAttribute with a MemberName property of either an array of SoapHeader, SoapHeader, SoapUnknownHeader or an array of SoapUnknownHeader to the XML Web service method. Specifying a Type of SoapUnknownHeader, allows the XML Web service to view the contents of the SOAP header in the form of an XmlElement.
Example
[Visual Basic, C#] The MyWebService XML Web service accepts and processes the MyHeader SOAP header sent with any calls to the MyWebMethod XML Web service method. Additionally, MyWebMethod receives any SOAP headers other than the MyHeader SOAP header.
[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
Namespace: System.Web.Services.Protocols
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
Assembly: System.Web.Services (in System.Web.Services.dll)
See Also
SoapUnknownHeader Members | System.Web.Services.Protocols Namespace | SoapHeaderAttribute | SoapHeader