-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ValueCollectionParameterReader.xml
226 lines (215 loc) · 16.1 KB
/
ValueCollectionParameterReader.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<Type Name="ValueCollectionParameterReader" FullName="System.Web.Services.Protocols.ValueCollectionParameterReader">
<TypeSignature Language="C#" Value="public abstract class ValueCollectionParameterReader : System.Web.Services.Protocols.MimeParameterReader" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ValueCollectionParameterReader extends System.Web.Services.Protocols.MimeParameterReader" />
<TypeSignature Language="DocId" Value="T:System.Web.Services.Protocols.ValueCollectionParameterReader" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ValueCollectionParameterReader
Inherits MimeParameterReader" />
<TypeSignature Language="F#" Value="type ValueCollectionParameterReader = class
 inherit MimeParameterReader" />
<TypeSignature Language="C++ CLI" Value="public ref class ValueCollectionParameterReader abstract : System::Web::Services::Protocols::MimeParameterReader" />
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.Services.Protocols.MimeParameterReader</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Serves as a base class for readers of incoming request parameters for Web services implemented using HTTP but without SOAP.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.Services.Protocols.ValueCollectionParameterReader> and other classes in the <xref: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. The <xref:System.Web.Services.Protocols.ValueCollectionParameterReader> class provides, among other methods, a common <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Read%2A> method for all service-side readers of collections of name/value pairs into Web method parameters. The name/value pairs have been parsed from an incoming HTTP request.
You typically will not need to use <xref:System.Web.Services.Protocols.ValueCollectionParameterReader> or its descendant classes directly. The appropriate types are used according to settings in an ASP.NET configuration file (Web.config).
]]></format>
</remarks>
<altmember cref="T:System.Web.Services.Protocols.MimeFormatter" />
<altmember cref="T:System.Web.Services.Protocols.MimeParameterReader" />
<altmember cref="T:System.Web.Services.Protocols.HtmlFormParameterReader" />
<altmember cref="T:System.Web.Services.Protocols.UrlParameterReader" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ValueCollectionParameterReader ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ValueCollectionParameterReader();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.ValueCollectionParameterReader" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetInitializer">
<MemberSignature Language="C#" Value="public override object GetInitializer (System.Web.Services.Protocols.LogicalMethodInfo methodInfo);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object GetInitializer(class System.Web.Services.Protocols.LogicalMethodInfo methodInfo) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.GetInitializer(System.Web.Services.Protocols.LogicalMethodInfo)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetInitializer (methodInfo As LogicalMethodInfo) As Object" />
<MemberSignature Language="F#" Value="override this.GetInitializer : System.Web.Services.Protocols.LogicalMethodInfo -> obj" Usage="valueCollectionParameterReader.GetInitializer methodInfo" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ GetInitializer(System::Web::Services::Protocols::LogicalMethodInfo ^ methodInfo);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="methodInfo" Type="System.Web.Services.Protocols.LogicalMethodInfo" />
</Parameters>
<Docs>
<param name="methodInfo">A <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> that specifies the Web method for which the initializer is obtained.</param>
<summary>Returns an initializer for the specified method.</summary>
<returns>A <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> representing the Web method.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The object returned by the <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.GetInitializer%2A> method is the <xref:System.Web.Services.Protocols.LogicalMethodInfo.InParameters%2A> property of the `methodinfo` parameter. The <xref:System.Web.Services.Protocols.LogicalMethodInfo.InParameters%2A> property value is an array of type <xref:System.Reflection.ParameterInfo>.
The <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.GetInitializer%2A> method is invoked during service initialization. Later, at the time a request is processed, the initializer object is passed to the <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Initialize%2A> method of another <xref:System.Web.Services.Protocols.ValueCollectionParameterReader> instance. The other instance performs the actual reading.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public override void Initialize (object o);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Initialize(object o) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.Initialize(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Initialize (o As Object)" />
<MemberSignature Language="F#" Value="override this.Initialize : obj -> unit" Usage="valueCollectionParameterReader.Initialize o" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Initialize(System::Object ^ o);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<param name="o">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>
<summary>Initializes an instance.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Initialize%2A> method is invoked at the time a request is processed.
The input parameter, `o`, is obtained by calling the <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.GetInitializer%2A> method on another instance during service initialization.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="IsSupported">
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Determines whether a method definition's parameter definitions are supported by the <see cref="T:System.Web.Services.Protocols.ValueCollectionParameterReader" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName="IsSupported">
<MemberSignature Language="C#" Value="public static bool IsSupported (System.Reflection.ParameterInfo paramInfo);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsSupported(class System.Reflection.ParameterInfo paramInfo) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.IsSupported(System.Reflection.ParameterInfo)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function IsSupported (paramInfo As ParameterInfo) As Boolean" />
<MemberSignature Language="F#" Value="static member IsSupported : System.Reflection.ParameterInfo -> bool" Usage="System.Web.Services.Protocols.ValueCollectionParameterReader.IsSupported paramInfo" />
<MemberSignature Language="C++ CLI" Value="public:
 static bool IsSupported(System::Reflection::ParameterInfo ^ paramInfo);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="paramInfo" Type="System.Reflection.ParameterInfo" />
</Parameters>
<Docs>
<param name="paramInfo">A <see cref="T:System.Reflection.ParameterInfo" /> that specifies the parameter to check.</param>
<summary>Determines whether a particular parameter type is supported by the <see cref="T:System.Web.Services.Protocols.ValueCollectionParameterReader" /> class.</summary>
<returns>
<see langword="true" /> if a method's parameter definitions are supported by the reader; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSupported">
<MemberSignature Language="C#" Value="public static bool IsSupported (System.Web.Services.Protocols.LogicalMethodInfo methodInfo);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsSupported(class System.Web.Services.Protocols.LogicalMethodInfo methodInfo) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.IsSupported(System.Web.Services.Protocols.LogicalMethodInfo)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function IsSupported (methodInfo As LogicalMethodInfo) As Boolean" />
<MemberSignature Language="F#" Value="static member IsSupported : System.Web.Services.Protocols.LogicalMethodInfo -> bool" Usage="System.Web.Services.Protocols.ValueCollectionParameterReader.IsSupported methodInfo" />
<MemberSignature Language="C++ CLI" Value="public:
 static bool IsSupported(System::Web::Services::Protocols::LogicalMethodInfo ^ methodInfo);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="methodInfo" Type="System.Web.Services.Protocols.LogicalMethodInfo" />
</Parameters>
<Docs>
<param name="methodInfo">A <see cref="T:System.Web.Services.Protocols.LogicalMethodInfo" /> that specifies the method to check.</param>
<summary>Determines whether a method definition's parameter definitions are supported by the <see cref="T:System.Web.Services.Protocols.ValueCollectionParameterReader" /> class.</summary>
<returns>
<see langword="true" /> if a method's parameter definitions are supported by the reader; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="protected object[] Read (System.Collections.Specialized.NameValueCollection collection);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance object[] Read(class System.Collections.Specialized.NameValueCollection collection) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.ValueCollectionParameterReader.Read(System.Collections.Specialized.NameValueCollection)" />
<MemberSignature Language="VB.NET" Value="Protected Function Read (collection As NameValueCollection) As Object()" />
<MemberSignature Language="F#" Value="override this.Read : System.Collections.Specialized.NameValueCollection -> obj[]" Usage="valueCollectionParameterReader.Read collection" />
<MemberSignature Language="C++ CLI" Value="protected:
 cli::array <System::Object ^> ^ Read(System::Collections::Specialized::NameValueCollection ^ collection);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="collection" Type="System.Collections.Specialized.NameValueCollection" />
</Parameters>
<Docs>
<param name="collection">A <see cref="T:System.Collections.Specialized.NameValueCollection" /> object that specifies the collection of name/value pairs containing method parameter names and values.</param>
<summary>Translates a collection of name/value pairs into an array of objects representing method parameter values.</summary>
<returns>An array of <see cref="T:System.Object" /> objects representing method parameter values.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Read%2A> method is called by the <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Read%2A> method defined in the two classes derived from <xref:System.Web.Services.Protocols.ValueCollectionParameterReader>, <xref:System.Web.Services.Protocols.UrlParameterReader> and <xref:System.Web.Services.Protocols.HtmlFormParameterReader>. Those two classes' <xref:System.Web.Services.Protocols.ValueCollectionParameterReader.Read%2A> methods take an <xref:System.Web.HttpRequest> parameter.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>