This documentation is archived and is not being maintained.

SoapHeaderAttribute::Required Property

NOTE: This API is now obsolete.

This member is obsolete and has no functionality.

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

[ObsoleteAttribute(L"This property will be removed from a future version. The presence of a particular header in a SOAP message is no longer enforced", 
	false)]
public:
property bool Required {
	bool get ();
	void set (bool value);
}

Property Value

Type: System::Boolean
A Boolean value.

To verify that a SOAP header is sent to an XML Web service, confirm that the member specified in the MemberName property is nullptr. If it is nullptr, the SOAP header was not sent.

In version 1.0 of the .NET Framework SDK, the Required property indicates whether a SOAP header must be understood and processed by the recipient XML Web service or XML Web service client. If a recipient did not process the SOAP header an exception was thrown.

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 1.0
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 3.5 SP1
Obsolete (compiler warning) in 3.0
Obsolete (compiler warning) in 3.0 SP1
Obsolete (compiler warning) in 3.0 SP2
Obsolete (compiler warning) in 2.0
Obsolete (compiler warning) in 2.0 SP1
Obsolete (compiler warning) in 2.0 SP2
Obsolete (compiler warning) in 1.1

.NET Compact Framework

Supported in: 1.0
Obsolete (compiler warning) in 3.5
Obsolete (compiler warning) in 2.0
Show: