189 lines
12 KiB
XML
189 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="UrlEncodedParameterWriter" FullName="System.Web.Services.Protocols.UrlEncodedParameterWriter">
|
|
<TypeSignature Language="C#" Value="public abstract class UrlEncodedParameterWriter : System.Web.Services.Protocols.MimeParameterWriter" Maintainer="auto" />
|
|
<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.Web.Services.Protocols.MimeParameterWriter</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>
|
|
<see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> and other classes in the <see cref="N:System.Web.Services.Protocols" /> namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard.</para>
|
|
<para>The abstract <see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> class inherits from the abstract <see cref="T:System.Web.Services.Protocols.MimeParameterWriter" /> class, adding URL encoding functionality for client-side writing of Web method parameters into HTTP request streams.</para>
|
|
<para>You typically will not need to use <see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> or its descendant classes directly. Instead, when the Wsdl.exe tool generates client proxy code according to the HTTP-GET or HTTP-POST implementations, it applies the <see cref="T:System.Web.Services.Protocols.HttpMethodAttribute" /> to each Web method and sets the attribute's <see cref="P:System.Web.Services.Protocols.HttpMethodAttribute.ParameterFormatter" /> property to the appropriate type.</para>
|
|
<block subset="none" type="note">
|
|
<para>The Hypertext Transfer Protocol--HTTP/1.1 specifies the use of a variation on Multipurpose Internet Mail Extensions (MIME) message format, which itself allows e-mail messages to specify different content types, both text and binary.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides URL encoding functionality for writers of out-going request parameters for Web service clients implemented using HTTP but without SOAP.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected UrlEncodedParameterWriter ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Encode">
|
|
<MemberSignature Language="C#" Value="protected void Encode (System.IO.TextWriter writer, object[] values);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="writer" Type="System.IO.TextWriter" />
|
|
<Parameter Name="values" Type="System.Object[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This overload of the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Encode(System.IO.TextWriter,System.Object[])" /> method calls the other overload, <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Encode(System.IO.TextWriter,System.String,System.Object)" />, for each of the parameter values, including individual items in arrays.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Encodes all the parameter values for a Web method and writes them to the specified writer.</para>
|
|
</summary>
|
|
<param name="writer">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.TextWriter" /> object that does the writing to the HTTP request.</param>
|
|
<param name="values">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The Web method parameter values.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Encode">
|
|
<MemberSignature Language="C#" Value="protected void Encode (System.IO.TextWriter writer, string name, object value);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="writer" Type="System.IO.TextWriter" />
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The other signature of the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Encode(System.IO.TextWriter,System.String,System.Object)" /> method, <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Encode(System.IO.TextWriter,System.Object[])" />, which is called for each Web method, calls this signature of the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Encode(System.IO.TextWriter,System.String,System.Object)" /> method for each of the parameter values, including individual items in arrays.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Encodes a specified parameter value and writes it to the specified writer.</para>
|
|
</summary>
|
|
<param name="writer">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.TextWriter" /> object that does the writing to the HTTP request.</param>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The name of the parameter that will be encoded.</param>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The value of the parameter that will be encoded.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="GetInitializer">
|
|
<MemberSignature Language="C#" Value="public override object GetInitializer (System.Web.Services.Protocols.LogicalMethodInfo methodInfo);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="methodInfo" Type="System.Web.Services.Protocols.LogicalMethodInfo" />
|
|
</Parameters>
|
|
<Docs>
|
|
<returns>a <see cref="T:System.Object" /></returns>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An initializer is an object passed as a parameter to the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Initialize(System.Object)" /> method. For the <see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> class, the initializer is the value of the <see cref="P:System.Web.Services.Protocols.LogicalMethodInfo.InParameters" /> property of the input <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> object. The property is a <see cref="T:System.Reflection.ParameterInfo" /> array.The <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo)" /> method is invoked during service initialization. Later, at the time a request is populated, the initializer object is passed to the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Initialize(System.Object)" /> method of another <see cref="T:System.Web.Services.Protocols.UrlEncodedParameterWriter" /> instance. The other object performs the actual writing.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns an initializer for the specified method.</para>
|
|
</summary>
|
|
<param name="methodInfo">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> that specifies the Web method for which the initializer is obtained.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Initialize">
|
|
<MemberSignature Language="C#" Value="public override void Initialize (object initializer);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="initializer" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.Initialize(System.Object)" /> method is invoked at the time a request is populated.</para>
|
|
<para>The input parameter, <paramref name="initializer" />, is obtained by calling the <see cref="M:System.Web.Services.Protocols.UrlEncodedParameterWriter.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo)" /> method on another instance during client initialization.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes an instance.</para>
|
|
</summary>
|
|
<param name="initializer">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Reflection.ParameterInfo" /> array obtained through the <see cref="P:System.Web.Services.Protocols.LogicalMethodInfo.InParameters" /> property of the <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> class.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="RequestEncoding">
|
|
<MemberSignature Language="C#" Value="public override System.Text.Encoding RequestEncoding { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Text.Encoding</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>a <see cref="T:System.Text.Encoding" /></value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An encoding, as represented by the <see cref="T:System.Text.Encoding" /> class, defines how to transform characters into a sequence of bytes.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the encoding used to write parameters to the HTTP request.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |