148 lines
11 KiB
XML
148 lines
11 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="SoapHeaderAttribute" FullName="System.Web.Services.Protocols.SoapHeaderAttribute">
|
||
|
|
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class SoapHeaderAttribute : Attribute" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Web.Services</AssemblyName>
|
||
|
|
<AssemblyPublicKey>
|
||
|
|
</AssemblyPublicKey>
|
||
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Attribute</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The basic steps to receiving and processing a SOAP header are: </para>
|
||
|
|
<list type="ordered">
|
||
|
|
<item>
|
||
|
|
<para>Create a class deriving from <see cref="T:System.Web.Services.Protocols.SoapHeader" /> representing the data passed in the SOAP header.</para>
|
||
|
|
</item>
|
||
|
|
<item>
|
||
|
|
<para>Add a member to the XML Web service class or XML Web service client proxy class of the type created in step 1.</para>
|
||
|
|
</item>
|
||
|
|
<item>
|
||
|
|
<para>Apply a <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> to the XML Web service method or the corresponding method in the proxy class, specifying the member created in step 2 in the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property.</para>
|
||
|
|
</item>
|
||
|
|
<item>
|
||
|
|
<para>Within the XML Web service method or XML Web service client code, access the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property to process the data sent in the SOAP header.</para>
|
||
|
|
</item>
|
||
|
|
</list>
|
||
|
|
<para>For more details, see the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>This attribute is applied to an XML Web service method or an XML Web service client to specify a SOAP header that the XML Web service method or XML Web service client can process. This class cannot be inherited.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public SoapHeaderAttribute (string memberName);" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<ReturnValue />
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="memberName" Type="System.String" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An XML Web service client or XML Web service can specify the SOAP headers it wants to process for specific XML Web service methods by applying a <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> to the XML Web service method in the XML Web service class or the corresponding method in the proxy class. In order for the XML Web service method to receive the contents of the SOAP header, a member is added to the XML Web service class of a <see cref="T:System.Type" /> derived from <see cref="T:System.Web.Services.Protocols.SoapHeader" />. Likewise, an XML Web service client adds a member to the proxy class deriving from <see cref="T:System.Web.Services.Protocols.SoapHeader" />. That <see cref="T:System.Type" /> deriving from <see cref="T:System.Web.Services.Protocols.SoapHeader" /> represents the contents of the SOAP header and is created by the developer of the XML Web service or XML Web service client that wants to receive the SOAP header. Once the class is created, a <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> can be applied to the XML Web service method or corresponding method in the XML Web service client proxy class specifing the member to receive the SOAP header contents with the <paramref name="memberName" /> parameter to this constructor or the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property.</para>
|
||
|
|
<para>An XML Web service method can receive multiple SOAP headers by adding multiple members to the XML Web service class or the XML Web service proxy class and in turn applying multiple <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> attributes to the XML Web service method.</para>
|
||
|
|
<para>To receive and process unknown SOAP headers at the time the XML Web service is written, specify the <see cref="T:System.Type" /> of the member to be either <see cref="T:System.Web.Services.Protocols.SoapUnknownHeader" />, <see cref="T:System.Web.Services.Protocols.SoapHeader" /> or an array of either class.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> class, setting the member of the XML Web service class representing the SOAP header contents.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="memberName">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The member of the XML Web service class representing the SOAP header contents. The <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property will be set to the value of this parameter. </param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Direction">
|
||
|
|
<MemberSignature Language="C#" Value="public System.Web.Services.Protocols.SoapHeaderDirection Direction { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Web.Services.Protocols.SoapHeaderDirection</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<value>To be added: an object of type 'SoapHeaderDirection'</value>
|
||
|
|
<remarks>To be added</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets whether the SOAP header is intended for the XML Web service or the XML Web service client or both.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="MemberName">
|
||
|
|
<MemberSignature Language="C#" Value="public string MemberName { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.String</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<value>To be added: an object of type 'string'</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An XML Web service or XML Web service client can specify the SOAP headers it wants to process by applying a <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> to the XML Web service method in the XML Web service class or the corresponding method in the proxy class. In order for the XML Web service method to receive the contents of the SOAP header, a member is added to the XML Web service class of a type derived from <see cref="T:System.Web.Services.Protocols.SoapHeader" />. Likewise, an XML Web service client adds a member to the proxy class deriving from <see cref="T:System.Web.Services.Protocols.SoapHeader" />. The <see cref="T:System.Type" /> deriving from <see cref="T:System.Web.Services.Protocols.SoapHeader" /> represents the contents of the SOAP header and is created by the developer of the XML Web service or XML Web service client that wants to receive the SOAP header. Once the class is created, a <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> can be applied to the XML Web service method or corresponding method in the XML Web service client proxy class specifying the member to receive the SOAP header contents with the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property.</para>
|
||
|
|
<para>An XML Web service method can receive multiple SOAP headers by adding multiple members to the XML Web service class or the XML Web service proxy class and in turn applying multiple <see cref="T:System.Web.Services.Protocols.SoapHeaderAttribute" /> attributes to the XML Web service method.</para>
|
||
|
|
<para>To receive and process unknown SOAP headers at the time the XML Web service is written, specify the type of the member to be either <see cref="T:System.Web.Services.Protocols.SoapUnknownHeader" />, <see cref="T:System.Web.Services.Protocols.SoapHeader" /> or an array of either class.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets the member of the XML Web service class representing the SOAP header contents.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Required">
|
||
|
|
<MemberSignature Language="C#" Value="public bool Required { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<value>To be added: an object of type 'bool'</value>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>To verify that a SOAP header is sent to an XML Web service, confirm that the member specified in the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.MemberName" /> property is null. If it is null, the SOAP header was not sent.</para>
|
||
|
|
<para>In version 1.0 of the .NET Framework SDK, the <see cref="P:System.Web.Services.Protocols.SoapHeaderAttribute.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.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>This member is obsolete and has no functionality.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Obsolete("This property will be removed from a future version. The presence of a particular header in a SOAP message is no longer enforced", false)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|