.NET Framework Class Library
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.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.Services.ProtocolsSoapHeaderAttribute

Namespace:   System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
Syntax
<[%$TOPIC/96ts33cc_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/96ts33cc_en-us_VS_110_2_0_0_0_1%].Method, AllowMultiple := True)> _
Public NotInheritable Class SoapHeaderAttribute _
	Inherits [%$TOPIC/96ts33cc_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/96ts33cc_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/96ts33cc_en-us_VS_110_2_0_1_0_1%].Method, AllowMultiple = true)]
public sealed class SoapHeaderAttribute : [%$TOPIC/96ts33cc_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/96ts33cc_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/96ts33cc_en-us_VS_110_2_0_2_0_1%]::Method, AllowMultiple = true)]
public ref class SoapHeaderAttribute sealed : public [%$TOPIC/96ts33cc_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/96ts33cc_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/96ts33cc_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/96ts33cc_en-us_VS_110_2_0_3_0_2%].Method, AllowMultiple = true)>]
type SoapHeaderAttribute =  
    class 
        inherit [%$TOPIC/96ts33cc_en-us_VS_110_2_0_3_0_3%] 
    end
public final class SoapHeaderAttribute extends [%$TOPIC/96ts33cc_en-us_VS_110_2_0_4_0_0%]

The SoapHeaderAttribute type exposes the following members.

Constructors
  NameDescription
Public method SoapHeaderAttributeInitializes a new instance of the SoapHeaderAttribute class, setting the member of the XML Web service class representing the SOAP header contents.
Top
Properties
  NameDescription
Public property DirectionGets or sets whether the SOAP header is intended for the XML Web service or the XML Web service client or both.
Public property MemberNameGets or sets the member of the XML Web service class representing the SOAP header contents.
Public property RequiredObsolete. This member is obsolete and has no functionality.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The basic steps to receiving and processing a SOAP header are:

  1. Create a class deriving from SoapHeader representing the data passed in the SOAP header.

  2. Add a member to the XML Web service class or XML Web service client proxy class of the type created in step 1.

  3. 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.

  4. 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.

Examples

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.

<%@ 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
<%@ 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;
       }
    }
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
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.