SoapHeader.EncodedMustUnderstand Property

Definition

Namespace:

System.Web.Services.Protocols

Assembly:

System.Web.Services.dll

Gets or sets the value of the mustUnderstand XML attribute for the SOAP header when communicating with SOAP protocol version 1.1.

public:
 property System::String ^ EncodedMustUnderstand { System::String ^ get(); void set(System::String ^ value); };

public string EncodedMustUnderstand { get; set; }

member this.EncodedMustUnderstand : string with get, set

Public Property EncodedMustUnderstand As String

Property Value

String

The value of the mustUnderstand attribute. The default is "0".

Exceptions

ArgumentException

The property is set to a value other than: "0", "1", "true", or "false".

Examples

// MyHeader class is derived from the SoapHeader class.
MyHeader ^ customHeader = gcnew MyHeader;
customHeader->MyValue = "Header value for MyValue";

// Set the EncodedMustUnderstand property to true.
customHeader->EncodedMustUnderstand = "1";
WebService_SoapHeader_EncodedMustUnderstand ^ myWebService = gcnew WebService_SoapHeader_EncodedMustUnderstand;
myWebService->myHeader1 = customHeader;
String^ results = myWebService->MyWebMethod1();
Console::WriteLine( results );
try
{
   results = myWebService->MyWebMethod2();
}
catch ( Exception^ myException ) 
{
   Console::WriteLine( "Exception raised in MyWebMethod2." );
   Console::WriteLine( "Message: {0}", myException->Message );
}

// MyHeader class is derived from the SoapHeader class.
MyHeader customHeader = new MyHeader();
customHeader.MyValue = "Header value for MyValue";

// Set the EncodedMustUnderstand property to true.
customHeader.EncodedMustUnderstand = "1";

WebService_SoapHeader_EncodedMustUnderstand myWebService =
    new WebService_SoapHeader_EncodedMustUnderstand();
myWebService.MyHeaderValue = customHeader;
string results = myWebService.MyWebMethod1();
Console.WriteLine(results);
try
{
    results = myWebService.MyWebMethod2();
}
catch(Exception myException)
{
    Console.WriteLine("Exception raised in MyWebMethod2.");
    Console.WriteLine("Message: " + myException.Message);
}

' MyHeader class inherits from the SoapHeader class.
Dim customHeader As New MyHeader()
customHeader.MyValue = "Header value for MyValue"

' Set the EncodedMustUnderstand property to true.
customHeader.EncodedMustUnderstand = "1"

Dim myWebService As New WebService_SoapHeader_EncodedMustUnderstand()
myWebService.MyHeaderValue = customHeader
Dim results As String = myWebService.MyWebMethod1()
Console.WriteLine(results)
Try
    results = myWebService.MyWebMethod2()
Catch myException As Exception
    Console.WriteLine("Exception raised in MyWebMethod2.")
    Console.WriteLine("Message: " & myException.Message)
End Try

Remarks

Do not use this property. Instead use the MustUnderstand property.

See also

• MustUnderstand