SoapHeader Class
When overridden in a derived class, represents the content of a SOAP header.
System.Web.Services.Protocols::SoapHeader
System.Web.Services.Protocols::SoapUnknownHeader
Assembly: System.Web.Services (in System.Web.Services.dll)
The SoapHeader type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Actor | Gets or sets the recipient of the SOAP header. |
![]() | DidUnderstand | Gets or sets a value indicating whether an XML Web service method properly processed a SOAP header. |
![]() | EncodedMustUnderstand | Gets or sets the value of the mustUnderstand XML attribute for the SOAP header when communicating with SOAP protocol version 1.1. |
![]() | EncodedMustUnderstand12 | Gets or sets the value of the mustUnderstand XML attribute for the SOAP header when communicating with SOAP protocol version 1.2. |
![]() | EncodedRelay | Gets or sets the relay attribute of the SOAP 1.2 header. |
![]() | MustUnderstand | Gets or sets a value indicating whether the SoapHeader must be understood. |
![]() | Relay | Gets or sets a value that indicates whether the SOAP header is to be relayed to the next SOAP node if the current node does not understand the header. |
![]() | Role | Gets or sets the recipient of the SOAP header. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
SOAP headers offer a method for passing data to and from an XML Web service method if the data is not directly related to the XML Web service method's primary functionality. For instance, an XML Web service might contain several XML Web service methods that each require a custom authentication scheme. Instead of adding parameters to each XML Web service method for the custom authentication scheme, a SoapHeaderAttribute, referring to a class deriving from SoapHeader, can be applied to each XML Web service method. The implementation for the class deriving from SoapHeader handles the custom authentication scheme. In this manner, the XML Web service method implements only the functionality specific to it and adds additional functionality using a SOAP header.
The following list outlines the basic steps to receiving and processing a SOAP header:
Create a class that derives from SoapHeader representing the data passed into the SOAP header.
Add a member to the class implementing an XML Web service or an XML Web service client proxy class, of the type created in the first step.
Apply a SoapHeaderAttribute to the XML Web service method or the corresponding method in the proxy class, specifying the member created in the second step 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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.


