File: WebResponse.xml

package info (click to toggle)
monodoc 1.9-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 98,436 kB
  • ctags: 5,261
  • sloc: xml: 1,506,218; cs: 40,827; sh: 3,647; perl: 554; makefile: 476
file content (514 lines) | stat: -rwxr-xr-x 23,008 bytes parent folder | download | duplicates (5)
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
<Type Name="WebResponse" FullName="System.Net.WebResponse" FullNameSP="System_Net_WebResponse" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public abstract serializable WebResponse extends System.MarshalByRefObject implements System.IDisposable" />
  <TypeSignature Language="C#" Value="public abstract class WebResponse : MarshalByRefObject, IDisposable, System.Runtime.Serialization.ISerializable" />
  <MemberOfLibrary>Networking</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.x.x</AssemblyVersion>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  <Base>
    <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>
      <para>Represents a response received from a Uniform Resource Identifier
      (URI).</para>
    </summary>
    <remarks>
      <para>
        <see cref="T:System.Net.WebResponse" /> is the base
   class from which protocol-specific response classes, such as <see cref="T:System.Net.HttpWebResponse" />
   , are derived.</para>
      <para>Classes that derive from <see cref="T:System.Net.WebResponse" /> are required to
override the following members in the <see cref="T:System.Net.WebResponse" /> class: </para>
      <list type="bullet">
        <item>
          <term>
            <see cref="P:System.Net.WebResponse.ContentLength" />: Gets or sets the content length of 
      the data being received.</term>
        </item>
        <item>
          <term>
            <see cref="P:System.Net.WebResponse.ContentType" />: Gets or sets the media type of the 
      data being received.</term>
        </item>
        <item>
          <term>
            <see cref="M:System.Net.WebResponse.GetResponseStream" />: Returns a
   <see cref="T:System.IO.Stream" /> that contains data from 
      the current host.</term>
        </item>
        <item>
          <term>
            <see cref="P:System.Net.WebResponse.ResponseUri" />: Gets a <see cref="T:System.Uri" /> containing the URI of the resource associated with the 
      current instance.</term>
        </item>
        <item>
          <term>
            <see cref="P:System.Net.WebResponse.Headers" />:
      Gets or sets the collection of header name/value pairs associated with the
      current instance.</term>
        </item>
      </list>
      <block subset="none" type="note">
        <para> Applications can participate in request/response transactions in a
      protocol-agnostic manner using instances of the <see cref="T:System.Net.WebResponse" /> class while
      protocol-specific classes derived from <see cref="T:System.Net.WebResponse" />
      
      carry
      out the details of the
      request.</para>
        <para> Applications do not create <see cref="T:System.Net.WebResponse" />
objects directly; they are created by calling <see cref="M:System.Net.WebRequest.GetResponse" />
.</para>
      </block>
    </remarks>
    <example>
      <para>The following example creates a <see cref="T:System.Net.WebResponse" />
instance from a <see cref="T:System.Net.WebRequest" />
.</para>
      <code lang="C#">using System;
using System.Net;

public class WebResponseExample {

  public static void Main() {

    // Initialize the WebRequest.
    WebRequest myRequest =
      WebRequest.Create("http://www.contoso.com");

    // Return the response. 
    WebResponse myResponse = myRequest.GetResponse();

    // Code to use the WebResponse goes here.

    // Close the response to free resources.
    myResponse.Close();
  }
}
</code>
    </example>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="family rtspecialname specialname instance void .ctor()" />
      <MemberSignature Language="C#" Value="protected WebResponse ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>
          <para>Constructs a new
      instance of the <see cref="T:System.Net.WebResponse" />
      class.</para>
        </summary>
        <remarks>
          <para>This constructor is called only by classes that derive from <see cref="T:System.Net.WebResponse" />.</para>
          <para>
            <block subset="none" type="note">To obtain a <see cref="T:System.Net.WebResponse" /> instance, use the <see cref="M:System.Net.WebRequest.GetResponse" /> method; do not use this
constructor.</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected WebResponse (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="serializationInfo">To be added.</param>
        <param name="streamingContext">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Close">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Close()" />
      <MemberSignature Language="C#" Value="public virtual void Close ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Closes the response stream.</para>
        </summary>
        <remarks>
          <para>
            <block subset="none" type="behaviors">This method is
      required to free the connection used by the <see cref="T:System.IO.Stream" /> returned by a call to <see cref="M:System.Net.WebResponse.GetResponseStream" /> .</block>
          </para>
          <para>
            <block subset="none" type="default">The <see cref="T:System.Net.WebResponse" /> class is 
   abstract and does not provide an implementation for this method. This method
   throws <see cref="T:System.NotSupportedException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">This method is
   required to be overridden in derived classes to close the response stream and
   free resources allocated by the current instance.</block>
          </para>
          <para>
            <block subset="none" type="usage">Use this method or
<see cref="M:System.IO.Stream.Close" qualify="true" /> to
   clean up the resources used by a <see cref="T:System.Net.WebResponse" /> .</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This method is not implemented in the derived class.</exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ContentLength">
      <MemberSignature Language="ILASM" Value=".property int64 ContentLength { public hidebysig virtual specialname int64 get_ContentLength() public hidebysig virtual specialname void set_ContentLength(int64 value) }" />
      <MemberSignature Language="C#" Value="public virtual long ContentLength { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Gets or sets the content length of the data received from the server.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Int64" />
containing the number of bytes returned from the resource.</para>
        </value>
        <remarks>
          <para>
            <block subset="none" type="behaviors">This
      property contains the number of bytes of data in the response to the
      request associated with the current instance. For request methods that contain
      header information, the <see cref="P:System.Net.WebResponse.ContentLength" /> does not include
      the length of the header information. The value of this property is
      set by the Content-Length header received in the
      response.</block>
          </para>
          <para>
            <block subset="none" type="default">The <see cref="T:System.Net.WebResponse" /> class 
   is abstract and does not provide an implementation for this property. This property throws <see cref="T:System.NotSupportedException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">This
   property is required to be overridden by classes that inherit from
<see cref="T:System.Net.WebResponse" /> to set the content length as appropriate for the 
   derived class. </block>
          </para>
          <para>
            <block subset="none" type="usage">Use this property to determine the number of bytes in the response.</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This property is not implemented in the derived class. </exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ContentType">
      <MemberSignature Language="ILASM" Value=".property string ContentType { public hidebysig virtual specialname string get_ContentType() public hidebysig virtual specialname void set_ContentType(string value) }" />
      <MemberSignature Language="C#" Value="public virtual string ContentType { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets or sets the media type of the data received.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.String" /> that
   contains the media type of the response data.</para>
        </value>
        <remarks>
          <para>
            <block subset="none" type="note">The media type is typically the MIME encoding of
      the content.</block>
          </para>
          <para>
            <block subset="none" type="behaviors">As described above.</block>
          </para>
          <para>
            <block subset="none" type="default">The <see cref="T:System.Net.WebResponse" /> class is abstract and 
   does not provide an implementation for this property. This property throws
<see cref="T:System.NotSupportedException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">This property is required to be overridden by classes that inherit from
<see cref="T:System.Net.WebResponse" />.</block>
          </para>
          <para>
            <block subset="none" type="usage">Use this
   property to get the media type of the response.</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This property is not implemented in the derived class. </exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetObjectData">
      <MemberSignature Language="C#" Value="protected virtual void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="serializationInfo">To be added.</param>
        <param name="streamingContext">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetResponseStream">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.IO.Stream GetResponseStream()" />
      <MemberSignature Language="C#" Value="public virtual System.IO.Stream GetResponseStream ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.IO.Stream</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Returns a <see cref="T:System.IO.Stream" /> that contains data from the current host.</para>
        </summary>
        <returns>
          <para> A <see cref="T:System.IO.Stream" /> for reading data from the
   current
   host.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors">This method is
      required to return a <see cref="T:System.IO.Stream" /> from the host specified by the <see cref="P:System.Net.WebResponse.ResponseUri" /> property of the current instance.</block>
          </para>
          <para>
            <block subset="none" type="default">This method throws <see cref="T:System.NotSupportedException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">This
   method is required to be overridden by classes that inherit from
<see cref="T:System.Net.WebResponse" />.</block>
          </para>
          <para>
            <block subset="none" type="usage">Use this method to open a connection to the current host. To close the stream when it
   is no longer needed, in order to prevent the exhaustion of system resources, invoke
   either the <see cref="M:System.IO.Stream.Close" qualify="true" /> or <see cref="M:System.Net.WebResponse.Close" />
   methods.</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This method is not implemented in the derived class. </exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Headers">
      <MemberSignature Language="ILASM" Value=".property class System.Net.WebHeaderCollection Headers { public hidebysig virtual specialname class System.Net.WebHeaderCollection get_Headers() }" />
      <MemberSignature Language="C#" Value="public virtual System.Net.WebHeaderCollection Headers { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.WebHeaderCollection</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets the collection of header name/value pairs associated with the current
      instance.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Net.WebHeaderCollection" /> containing the header name/value pairs associated
   with the current instance.</para>
        </value>
        <remarks>
          <para>This property contains a <see cref="T:System.Net.WebHeaderCollection" /> instance containing the
   header information returned in the response from the resource. </para>
          <para>
            <block subset="none" type="behaviors">This property is read-only.</block>
          </para>
          <para>
            <block subset="none" type="default">The <see cref="T:System.Net.WebResponse" /> class is
abstract and does not provide an implementation for this property. This property
throws <see cref="T:System.NotSupportedException" />.</block>
          </para>
          <para>
            <block subset="none" type="overrides">This property
   is required to be overridden by classes that inherit from <see cref="T:System.Net.WebResponse" />.</block>
          </para>
          <para>
            <block subset="none" type="usage">Use this property
   to retrieve the header information received with the response.</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This property is not implemented in the derived class. </exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsFromCache">
      <MemberSignature Language="C#" Value="public virtual bool IsFromCache { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsMutuallyAuthenticated">
      <MemberSignature Language="C#" Value="public virtual bool IsMutuallyAuthenticated { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResponseUri">
      <MemberSignature Language="ILASM" Value=".property class System.Uri ResponseUri { public hidebysig virtual specialname class System.Uri get_ResponseUri() }" />
      <MemberSignature Language="C#" Value="public virtual Uri ResponseUri { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Uri</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Gets the URI 
      of the resource associated with the current instance.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Uri" /> containing the URI 
   of the resource associated with the current response.</para>
        </value>
        <remarks>
          <block subset="none" type="behaviors">
            <para>This property is read-only.</para>
            <para>This property returns the URI that provided the response 
         information in the current instance. <block subset="none" type="note">If the
         method protocol used in the associated <see cref="T:System.Net.WebRequest" /> permits redirection, the value of this property
         might differ from the <see cref="P:System.Net.WebRequest.RequestUri" /> property of the request.</block></para>
          </block>
          <para>
            <block subset="none" type="default">The <see cref="T:System.Net.WebResponse" /> class is 
   abstract and does not provide an implementation for this property. This property
   throws <see cref="T:System.NotSupportedException" />
   .</block>
          </para>
          <para>
            <block subset="none" type="overrides">This property
   is required to be overridden by classes that inherit from <see cref="T:System.Net.WebResponse" />.</block>
          </para>
          <para>
            <block subset="none" type="usage">Use this property
   to determine the URI that originated the response.</block>
          </para>
        </remarks>
        <exception cref="T:System.NotSupportedException">This property is not implemented in the derived class. </exception>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="System.IDisposable.Dispose">
      <MemberSignature Language="ILASM" Value=".method private final hidebysig virtual void System.IDisposable.Dispose()" />
      <MemberSignature Language="C#" Value="void IDisposable.Dispose ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Implemented to support the <see cref="T:System.IDisposable" /> interface. [Note: For more information, see <see cref="M:System.IDisposable.Dispose" />.]</summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
      <MemberSignature Language="C#" Value="void ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="serializationInfo">To be added.</param>
        <param name="streamingContext">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>