SoapHeaderAttribute Class
This attribute is applied to an XML Web service method or an XML Web service client to specify a SOAP header that the XML Web service method or XML Web service client can process. This class cannot be inherited.
For a list of all members of this type, see SoapHeaderAttribute Members.
System.Object
System.Attribute
System.Web.Services.Protocols.SoapHeaderAttribute
[Visual Basic] <AttributeUsage(AttributeTargets.Method)> NotInheritable Public Class SoapHeaderAttribute Inherits Attribute [C#] [AttributeUsage(AttributeTargets.Method)] public sealed class SoapHeaderAttribute : Attribute [C++] [AttributeUsage(AttributeTargets::Method)] public __gc __sealed class SoapHeaderAttribute : public Attribute [JScript] public AttributeUsage(AttributeTargets.Method) class SoapHeaderAttribute extends Attribute
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
The basic steps to receiving and processing a SOAP header are:
- Create a class deriving from SoapHeader representing the data passed in the SOAP header.
- Add a member to the XML Web service class or XML Web service client proxy class of the type created in step 1.
- Apply a SoapHeaderAttribute to the XML Web service method or the corresponding method in the proxy class, specifying the member created in step 2 in the MemberName property.
- Within the XML Web service method or XML Web service client code, access the MemberName property to process the data sent in the SOAP header.
For more details, see the MemberName property.
Example
[Visual Basic, C#] The following MyWebService XML Web service defines one SoapHeader of type MyHeader. The Hello XML Web service method requires the client to invoke the XML Web service method with this SoapHeader. The Hello XML Web service also catches any SOAP headers other than MyHeader.
[Visual Basic] <%@ WebService Language="VB" Class="MyWebService"%> Imports System.Web.Services Imports System.Web.Services.Protocols ' Define a SOAP header by deriving from the SoapHeader base class. ' The header contains just one string value. Public Class MyHeader Inherits SoapHeader Public MyValue As String End Class Public Class MyWebService ' Member variable to receive the contents of the MyHeader SoapHeader. Public myHeader As MyHeader ' Member variable to receive all headers other than MyHeader. Public unknownHeaders() As SoapUnknownHeader ' Receive any SOAP headers other than MyHeader. <WebMethod, _ SoapHeader("myHeader", Direction := SoapHeaderDirection.InOut), _ SoapHeader("unknownHeaders")> _ Public Sub Hello() ' Process the MyHeader SoapHeader. If myHeader.MyValue = "Some string" Then ' Process the header. End If Dim header As SoapHeader For Each header In unknownHeaders ' Perform some processing on header ' For those headers that cannot be processed, ' set the DidUnderstand to false. header.DidUnderstand = False Next header End Sub End Class [C#] <%@ WebService Language="C#" Class="MyWebService"%> using System.Web.Services; using System.Web.Services.Protocols; // Define a SOAP header by deriving from the SoapHeader base class. // The header contains just one string value. public class MyHeader : SoapHeader { public string MyValue; } public class MyWebService { // Member variable to receive the contents of the MyHeader SoapHeader. public MyHeader myHeader; // Member variable to receive all headers other than MyHeader. public SoapUnknownHeader[] unknownHeaders; [WebMethod] [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)] // Receive any SOAP headers other than MyHeader. [SoapHeader("unknownHeaders")] public void Hello() { // Process the MyHeader SoapHeader. if (myHeader.MyValue == "Some string") { // Process the header. } foreach (SoapHeader header in unknownHeaders) { // Perform some processing on header. // For those headers that cannot be processed, // set the DidUnderstand property to false. header.DidUnderstand = false; } } }
[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
SoapHeaderAttribute Members | System.Web.Services.Protocols Namespace | MemberName | SoapHeader