This documentation is archived and is not being maintained.

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.

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

[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = true)]
public sealed class SoapHeaderAttribute : Attribute

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.

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="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;

    [SoapHeader("myHeader", Direction=SoapHeaderDirection.InOut)]

    // Receive any SOAP headers other than MyHeader.
    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;


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0