SoapHeader.Role Property

Definition

Namespace:

System.Web.Services.Protocols

Assembly:

System.Web.Services.dll

Gets or sets the recipient of the SOAP header.

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

[System.Runtime.InteropServices.ComVisible(false)]
public string Role { get; set; }

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.Role : string with get, set

Public Property Role As String

Property Value

String

A URI that represents the recipient of the SOAP header. The default is an empty string ("").

Attributes

ComVisibleAttribute

Remarks

To set the recipient of a SOAP header, set the Actor property. Regardless of the version of the SOAP protocol used to communicate with an XML Web service, the .NET Framework automatically generates the SOAP message specific to the version of the SOAP protocol. Specifically, the XML element and XML namespace representing the recipient differ for the two versions.

XML Web services receiving the SOAP header can get the intended recipient by getting either the Role or Actor properties.

The recipient(s) for the Body element and each of the SOAP headers within the Header element of a SOAP message need not be the same. If a Header element exists in the SOAP message, it represents additional data that can be sent to and from the XML Web service method or an intermediary. The recipient of that data, known as the SOAP Role in version 1.2 of the SOAP specification and the SOAP Actor in version 1.1, can be a different URI than the URI for the XML Web service method.

For more information on the SOAP actor attribute, see the SOAP specification.