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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="WebClientProtocol" FullName="System.Web.Services.Protocols.WebClientProtocol">
<TypeSignature Language="C#" Maintainer="auto" Value="public abstract class WebClientProtocol : System.ComponentModel.Component" />
<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.ComponentModel.Component</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The properties of the <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> class are used to control the behavior of the transport used to transmit the XML Web service request and response. The properties on this class map to properties found on <see cref="T:System.Net.WebRequest" />. Instances of classes deriving from <see cref="T:System.Net.WebRequest" />, such as <see cref="T:System.Net.HttpWebRequest" />, are used as the transport mechanism for XML Web services created using ASP.NET.</para>
<para>To communicate with an XML Web service, you must create a proxy class deriving indirectly or directly from <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> for the XML Web service you want to call. Instead of creating the proxy class manually, you can use the Wsdl.exe tool to create a proxy class for a given XML Web service's service description. Since <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> is the base class for your client proxy, you will find its properties on your proxy classes. These properties are useful for controlling the request behavior of the underlying transport. For instance, use the <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Credentials" /> property for calling authenticated XML Web services. Many of the <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> properties are used to initialize the <see cref="T:System.Net.WebRequest" /> object that is used to make the Web request.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies the base class for all XML Web service client proxies created using ASP.NET.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebClientProtocol ();" />
<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.WebClientProtocol" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Abort">
<MemberSignature Language="C#" Value="public virtual void Abort ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Cancels a request to an XML Web service method.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AddToCache">
<MemberSignature Language="C#" Value="protected static void AddToCache (Type type, object value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Add an instance of the client protocol handler to the cache.</para>
</summary>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the client protocol handler..</param>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />The client protocol handler to be added to the cache.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ConnectionGroupName">
<MemberSignature Language="C#" Value="public string ConnectionGroupName { 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>The <see cref="P:System.Web.Services.Protocols.WebClientProtocol.ConnectionGroupName" /> property enables you to associate a request to a connection group. For more details, see <see cref="P:System.Net.HttpWebRequest.ConnectionGroupName" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the connection group for the request.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Credentials">
<MemberSignature Language="C#" Value="public System.Net.ICredentials Credentials { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Net.ICredentials</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>a <see cref="T:System.Net.ICredentials" /></value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When using the Credentials property, a XML Web service client must instantiate a class implementing <see cref="T:System.Net.ICredentials" />, such as <see cref="T:System.Net.NetworkCredential" />, and then set the client credentials specific to the authentication mechanism. The <see cref="T:System.Net.NetworkCredential" /> class can be used to set authentication credentials using the basic, digest, NTLM and Kerberos authentication mechanisms.</para>
<para>When the <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Credentials" /> property is set to <see cref="P:System.Net.CredentialCache.DefaultCredentials" /> then the client negotiates with the server to do Kerberos and/or NTLM authentication depending on how the server is configured.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets security credentials for XML Web service client authentication.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetFromCache">
<MemberSignature Language="C#" Value="protected static object GetFromCache (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets an instance of a client protocol handler from the cache.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An instance of a client protocol handler from the cache.</para>
</returns>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the client protocol handler to be returned from the cache.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetWebRequest">
<MemberSignature Language="C#" Value="protected virtual System.Net.WebRequest GetWebRequest (Uri uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.WebRequest</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method can be overridden to customize the <see cref="T:System.Net.WebRequest" /> object before the XML Web service request is made. For example you could add a custom header to the request.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a <see cref="T:System.Net.WebRequest" /> instance for the specified <paramref name="uri" />. This protected method is called by the XML Web service client infrastructure to get a new <see cref="T:System.Net.WebRequest" /> transport object to transmit the XML Web service request.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.WebRequest" /> instance.</para>
</returns>
<param name="uri">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Uri" /> to use when creating the <see cref="T:System.Net.WebRequest" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetWebResponse">
<MemberSignature Language="C#" Value="protected virtual System.Net.WebResponse GetWebResponse (System.Net.WebRequest request);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.WebResponse</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="System.Net.WebRequest" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a response from a synchronous request to an XML Web service method.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A response from a synchronous request to an XML Web service method.</para>
</returns>
<param name="request">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.WebRequest" /> to get the response from. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetWebResponse">
<MemberSignature Language="C#" Value="protected virtual System.Net.WebResponse GetWebResponse (System.Net.WebRequest request, IAsyncResult result);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.WebResponse</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="System.Net.WebRequest" />
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a response from an asynchronous request to an XML Web service method. This protected method is called by the XML Web service client infrastructure to get the response from an asynchronous XML Web service request.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A response from an asynchronous request to an XML Web service method.</para>
</returns>
<param name="request">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.WebRequest" /> to get the response from. </param>
<param name="result">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IAsyncResult" /> to pass to <see cref="M:System.Net.HttpWebRequest.EndGetResponse(System.IAsyncResult)" /> when the response has completed. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PreAuthenticate">
<MemberSignature Language="C#" Value="public bool PreAuthenticate { 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>When a client requests a resource without using credentials, the server challenges the request and indicates what authentication schemes it supports. The client chooses an authentication scheme and sends the appropriate WWW-authenticate header to the server. When <see cref="P:System.Web.Services.Protocols.WebClientProtocol.PreAuthenticate" /> is true, the WWW-authenticate header is sent with all subsequent requests.</para>
<para>When <see cref="P:System.Web.Services.Protocols.WebClientProtocol.PreAuthenticate" /> is false, a request is made to the XML Web service method without initially attempting to authenticate the user. If the XML Web service allows anonymous access, then the XML Web service method is executed. If anonymous access is disallowed, a 401 HTTP return code is sent back to the client. In response, the <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> class returns authentication credentials to the Web server. If the client is authenticated and subsequently authorized to access the XML Web service, the XML Web service method is executed; otherwise the client is denied access.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets whether pre-authentication is enabled.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="RequestEncoding">
<MemberSignature Language="C#" Value="public 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>The <see cref="P:System.Web.Services.Protocols.WebClientProtocol.RequestEncoding" /> determines the encoding for the request message. The <see cref="P:System.Net.WebRequest.ContentType" /> of the request will be annotated with the encoding value.</para>
<para>Classes deriving from <see cref="T:System.Web.Services.Protocols.WebClientProtocol" /> support a particular protocol, such as <see cref="T:System.Web.Services.Protocols.SoapHttpClientProtocol" /> does for SOAP, set this property to conform to encoding requirements for the specific protocol. For example, the <see cref="T:System.Web.Services.Protocols.SoapHttpClientProtocol" /> sets the default encoding to UTF-8.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Text.Encoding" /> used to make the client request to the XML Web service.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.RecommendedAsConfigurable(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Timeout">
<MemberSignature Language="C#" Value="public int Timeout { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Setting the <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Timeout" /> property to <see cref="F:System.Threading.Timeout.Infinite" /> indicates that the request does not time out. Even though an XML Web service client can set the <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Timeout" /> property to not time out, the Web server can still cause the request to time out on the server side.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates the time an XML Web service client waits for the reply to a synchronous XML Web service request to arrive (in milliseconds).</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.RecommendedAsConfigurable(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(100000)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Url">
<MemberSignature Language="C#" Value="public string Url { 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>Proxy classes generated using Wsdl.exe will set a default <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Url" /> property for the client to use. The default <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Url" /> is determined by the location attribute found in the service description from which the proxy class was generated.</para>
<para>Derived classes supporting specific protocols, such as <see cref="T:System.Web.Services.Protocols.HttpGetClientProtocol" /> and <see cref="T:System.Web.Services.Protocols.HttpPostClientProtocol" /> might add extra information to <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Url" /> to make the XML Web service request.</para>
<para>The <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Url" /> property can be changed to refer to any XML Web service that implements the same service description that the proxy class was generated from.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the base URL of the XML Web service the client is requesting.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.RecommendedAsConfigurable(true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="UseDefaultCredentials">
<MemberSignature Language="C#" Value="public bool UseDefaultCredentials { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether to set the <see cref="P:System.Web.Services.Protocols.WebClientProtocol.Credentials" /> property to the value of the <see cref="P:System.Net.CredentialCache.DefaultCredentials" /> property.</para>
</summary>
</Docs>
</Member>
</Members>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
</Type>
|
