SoapHeaderDirection Enumeration
TOC
Collapse the table of content
Expand the table of content

SoapHeaderDirection Enumeration

 

Specifies whether the recipient of the SoapHeader is the XML Web service, the XML Web service client, or both.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

[FlagsAttribute]
public enum SoapHeaderDirection

Member nameDescription
Fault

Specifies the SoapHeader is sent to the XML Web service client when an exception is thrown by the XML Web service method.

In

Specifies the SoapHeader is sent to the XML Web service.

InOut

Specifies the SoapHeader is sent to both the XML Web service and the XML Web service client.

Out

Specifies the SoapHeader is sent to the XML Web service client.

A SoapHeaderAttribute can be applied to either an XML Web service method or a method of a proxy class to an XML Web service. In either case, the recipient(s) are specified by the Direction property of SoapHeaderAttribute. To specify that an XML Web service method returns a SOAP header when an exception is thrown during its execution, apply an SoapHeaderAttribute to the method and set the Direction property to Fault.

Version 1.0 of the .NET Framework does not support the Fault value.

The following XML Web service method specifies that the myHeaderSoapHeader is sent from the XML Web service client to the XML Web service and then back to the XML Web service client, regardless of an exception thrown during execution of the XML Web service method.

public class MyHeader : SoapHeader {
    public string MyValue;
}

public class MyWebService {

    public MyHeader myHeader;

    [WebMethod]
    [SoapHeader("myHeader", 
                Direction=SoapHeaderDirection.InOut | SoapHeaderDirection.Fault)]
    public void MySoapHeaderReceivingMethod() {

        // Set myHeader.MyValue to some value.

    }
}

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft