SoapHeader.MustUnderstand Property

Gets or sets a value indicating whether the SoapHeader must be understood.

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

public:
property bool MustUnderstand {
	bool get ();
	void set (bool value);
}
/** @property */
public boolean get_MustUnderstand ()

/** @property */
public void set_MustUnderstand (boolean value)

public function get MustUnderstand () : boolean

public function set MustUnderstand (value : boolean)

Not applicable.

Property Value

true if the XML Web service must properly interpret and process the SoapHeader; otherwise, false. The default is false.

When an XML Web service client adds a SOAP header to an XML Web service method call with the MustUnderstand property set to true, the XML Web service method must set the DidUnderstand property to true; otherwise, a SoapHeaderException is thrown back to the XML Web service client by ASP.NET.

Although both the EncodedMustUnderstand and MustUnderstand properties can be used to set the value of the mustUnderstand attribute within the SOAP header, the MustUnderstand property allows you to set the attribute using a Boolean value.

For details on adding SOAP headers to clients, see Using SOAP Headers.

The following XML Web service client defines a custom SOAP header of type MyHeader, sets the MustUnderstand property to true, and invokes the MyWebMethod XML Web service method. If the XML Web service method does not set the DidUnderstand property of the MyHeader SOAP header to true, a SoapHeaderException is thrown.

int main()
{
   MyWebService^ ws = gcnew MyWebService;
   try
   {
      MyHeader^ customHeader = gcnew MyHeader;
      customHeader->MyValue = "Header Value for MyValue";
      customHeader->MustUnderstand = true;
      ws->myHeader = customHeader;
      int results = ws->MyWebMethod( 3, 5 );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception: {0}", e );
   }

}


import System.*;

public class Sample
{
    public static void main(String[] args)
    {
        MyWebService ws = new MyWebService();
        try {
            MyHeader customHeader = new MyHeader();
            customHeader.myValue = "Header Value for MyValue";
            customHeader.set_MustUnderstand(true);
            ws.myHeader = customHeader;
            int results = ws.MyWebMethod(3, 5);
        }
        catch (System.Exception e) {
            Console.WriteLine("Exception: {0}", e.ToString());
        }
    } //main
} //Sample


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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show: