docupdate: updated System.dll documentation
[mono.git] / mcs / class / System / Documentation / en / System.Net / FileWebRequest.xml
1 <Type Name="FileWebRequest" FullName="System.Net.FileWebRequest">
2   <TypeSignature Language="C#" Maintainer="auto" Value="public class FileWebRequest : System.Net.WebRequest, System.Runtime.Serialization.ISerializable" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit FileWebRequest extends System.Net.WebRequest implements class System.Runtime.Serialization.ISerializable" />
4   <AssemblyInfo>
5     <AssemblyName>System</AssemblyName>
6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
11   </AssemblyInfo>
12   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
13   <Base>
14     <BaseTypeName>System.Net.WebRequest</BaseTypeName>
15   </Base>
16   <Interfaces>
17     <Interface>
18       <InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
19     </Interface>
20   </Interfaces>
21   <Docs>
22     <summary>To be added</summary>
23     <remarks>To be added</remarks>
24   </Docs>
25   <Members>
26     <Member MemberName=".ctor">
27       <MemberSignature Language="C#" Value="protected FileWebRequest (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
28       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
29       <MemberType>Constructor</MemberType>
30       <AssemblyInfo>
31         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
32         <AssemblyVersion>2.0.0.0</AssemblyVersion>
33         <AssemblyVersion>4.0.0.0</AssemblyVersion>
34       </AssemblyInfo>
35       <Attributes>
36         <Attribute>
37           <AttributeName>System.Obsolete("Serialization is obsoleted for this type", false)</AttributeName>
38         </Attribute>
39       </Attributes>
40       <ReturnValue />
41       <Parameters>
42         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
43         <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
44       </Parameters>
45       <Docs>
46         <param name="serializationInfo">To be added: an object of type 'Runtime.Serialization.SerializationInfo'</param>
47         <param name="streamingContext">To be added: an object of type 'Runtime.Serialization.StreamingContext'</param>
48         <summary>To be added</summary>
49         <remarks>To be added</remarks>
50       </Docs>
51     </Member>
52     <Member MemberName="Abort">
53       <MemberSignature Language="C#" Value="public override void Abort ();" />
54       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Abort() cil managed" />
55       <MemberType>Method</MemberType>
56       <AssemblyInfo>
57         <AssemblyVersion>2.0.0.0</AssemblyVersion>
58         <AssemblyVersion>4.0.0.0</AssemblyVersion>
59       </AssemblyInfo>
60       <Attributes>
61         <Attribute>
62           <AttributeName>System.MonoTODO</AttributeName>
63         </Attribute>
64       </Attributes>
65       <ReturnValue>
66         <ReturnType>System.Void</ReturnType>
67       </ReturnValue>
68       <Parameters />
69       <Docs>
70         <summary>To be added.</summary>
71         <remarks>To be added.</remarks>
72       </Docs>
73     </Member>
74     <Member MemberName="BeginGetRequestStream">
75       <MemberSignature Language="C#" Value="public override IAsyncResult BeginGetRequestStream (AsyncCallback callback, object state);" />
76       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginGetRequestStream(class System.AsyncCallback callback, object state) cil managed" />
77       <MemberType>Method</MemberType>
78       <AssemblyInfo>
79         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
80         <AssemblyVersion>2.0.0.0</AssemblyVersion>
81         <AssemblyVersion>4.0.0.0</AssemblyVersion>
82       </AssemblyInfo>
83       <ReturnValue>
84         <ReturnType>System.IAsyncResult</ReturnType>
85       </ReturnValue>
86       <Parameters>
87         <Parameter Name="callback" Type="System.AsyncCallback" />
88         <Parameter Name="state" Type="System.Object" />
89       </Parameters>
90       <Docs>
91         <param name="callback">To be added: an object of type 'AsyncCallback'</param>
92         <param name="state">To be added: an object of type 'object'</param>
93         <summary>To be added</summary>
94         <returns>To be added: an object of type 'IAsyncResult'</returns>
95         <remarks>To be added</remarks>
96       </Docs>
97     </Member>
98     <Member MemberName="BeginGetResponse">
99       <MemberSignature Language="C#" Value="public override IAsyncResult BeginGetResponse (AsyncCallback callback, object state);" />
100       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginGetResponse(class System.AsyncCallback callback, object state) cil managed" />
101       <MemberType>Method</MemberType>
102       <AssemblyInfo>
103         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
104         <AssemblyVersion>2.0.0.0</AssemblyVersion>
105         <AssemblyVersion>4.0.0.0</AssemblyVersion>
106       </AssemblyInfo>
107       <ReturnValue>
108         <ReturnType>System.IAsyncResult</ReturnType>
109       </ReturnValue>
110       <Parameters>
111         <Parameter Name="callback" Type="System.AsyncCallback" />
112         <Parameter Name="state" Type="System.Object" />
113       </Parameters>
114       <Docs>
115         <param name="callback">To be added: an object of type 'AsyncCallback'</param>
116         <param name="state">To be added: an object of type 'object'</param>
117         <summary>To be added</summary>
118         <returns>To be added: an object of type 'IAsyncResult'</returns>
119         <remarks>To be added</remarks>
120       </Docs>
121     </Member>
122     <Member MemberName="ConnectionGroupName">
123       <MemberSignature Language="C#" Value="public override string ConnectionGroupName { get; set; }" />
124       <MemberSignature Language="ILAsm" Value=".property instance string ConnectionGroupName" />
125       <MemberType>Property</MemberType>
126       <AssemblyInfo>
127         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
128         <AssemblyVersion>2.0.0.0</AssemblyVersion>
129         <AssemblyVersion>4.0.0.0</AssemblyVersion>
130       </AssemblyInfo>
131       <ReturnValue>
132         <ReturnType>System.String</ReturnType>
133       </ReturnValue>
134       <Parameters>
135       </Parameters>
136       <Docs>
137         <summary>To be added</summary>
138         <value>To be added: an object of type 'string'</value>
139         <remarks>To be added</remarks>
140       </Docs>
141     </Member>
142     <Member MemberName="ContentLength">
143       <MemberSignature Language="C#" Value="public override long ContentLength { get; set; }" />
144       <MemberSignature Language="ILAsm" Value=".property instance int64 ContentLength" />
145       <MemberType>Property</MemberType>
146       <AssemblyInfo>
147         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
148         <AssemblyVersion>2.0.0.0</AssemblyVersion>
149         <AssemblyVersion>4.0.0.0</AssemblyVersion>
150       </AssemblyInfo>
151       <ReturnValue>
152         <ReturnType>System.Int64</ReturnType>
153       </ReturnValue>
154       <Parameters>
155       </Parameters>
156       <Docs>
157         <summary>To be added</summary>
158         <value>To be added: an object of type 'long'</value>
159         <remarks>To be added</remarks>
160       </Docs>
161     </Member>
162     <Member MemberName="ContentType">
163       <MemberSignature Language="C#" Value="public override string ContentType { get; set; }" />
164       <MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
165       <MemberType>Property</MemberType>
166       <AssemblyInfo>
167         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
168         <AssemblyVersion>2.0.0.0</AssemblyVersion>
169         <AssemblyVersion>4.0.0.0</AssemblyVersion>
170       </AssemblyInfo>
171       <ReturnValue>
172         <ReturnType>System.String</ReturnType>
173       </ReturnValue>
174       <Parameters>
175       </Parameters>
176       <Docs>
177         <summary>To be added</summary>
178         <value>To be added: an object of type 'string'</value>
179         <remarks>To be added</remarks>
180       </Docs>
181     </Member>
182     <Member MemberName="Credentials">
183       <MemberSignature Language="C#" Value="public override System.Net.ICredentials Credentials { get; set; }" />
184       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.ICredentials Credentials" />
185       <MemberType>Property</MemberType>
186       <AssemblyInfo>
187         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
188         <AssemblyVersion>2.0.0.0</AssemblyVersion>
189         <AssemblyVersion>4.0.0.0</AssemblyVersion>
190       </AssemblyInfo>
191       <ReturnValue>
192         <ReturnType>System.Net.ICredentials</ReturnType>
193       </ReturnValue>
194       <Parameters>
195       </Parameters>
196       <Docs>
197         <summary>To be added</summary>
198         <value>To be added: an object of type 'ICredentials'</value>
199         <remarks>To be added</remarks>
200       </Docs>
201     </Member>
202     <Member MemberName="EndGetRequestStream">
203       <MemberSignature Language="C#" Value="public override System.IO.Stream EndGetRequestStream (IAsyncResult asyncResult);" />
204       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IO.Stream EndGetRequestStream(class System.IAsyncResult asyncResult) cil managed" />
205       <MemberType>Method</MemberType>
206       <AssemblyInfo>
207         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
208         <AssemblyVersion>2.0.0.0</AssemblyVersion>
209         <AssemblyVersion>4.0.0.0</AssemblyVersion>
210       </AssemblyInfo>
211       <ReturnValue>
212         <ReturnType>System.IO.Stream</ReturnType>
213       </ReturnValue>
214       <Parameters>
215         <Parameter Name="asyncResult" Type="System.IAsyncResult" />
216       </Parameters>
217       <Docs>
218         <param name="asyncResult">To be added: an object of type 'IAsyncResult'</param>
219         <summary>To be added</summary>
220         <returns>To be added: an object of type 'IO.Stream'</returns>
221         <remarks>To be added</remarks>
222       </Docs>
223     </Member>
224     <Member MemberName="EndGetResponse">
225       <MemberSignature Language="C#" Value="public override System.Net.WebResponse EndGetResponse (IAsyncResult asyncResult);" />
226       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.WebResponse EndGetResponse(class System.IAsyncResult asyncResult) cil managed" />
227       <MemberType>Method</MemberType>
228       <AssemblyInfo>
229         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
230         <AssemblyVersion>2.0.0.0</AssemblyVersion>
231         <AssemblyVersion>4.0.0.0</AssemblyVersion>
232       </AssemblyInfo>
233       <ReturnValue>
234         <ReturnType>System.Net.WebResponse</ReturnType>
235       </ReturnValue>
236       <Parameters>
237         <Parameter Name="asyncResult" Type="System.IAsyncResult" />
238       </Parameters>
239       <Docs>
240         <param name="asyncResult">To be added: an object of type 'IAsyncResult'</param>
241         <summary>To be added</summary>
242         <returns>To be added: an object of type 'WebResponse'</returns>
243         <remarks>To be added</remarks>
244       </Docs>
245     </Member>
246     <Member MemberName="GetObjectData">
247       <MemberSignature Language="C#" Value="protected override void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
248       <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
249       <MemberType>Method</MemberType>
250       <AssemblyInfo>
251         <AssemblyVersion>2.0.0.0</AssemblyVersion>
252         <AssemblyVersion>4.0.0.0</AssemblyVersion>
253       </AssemblyInfo>
254       <ReturnValue>
255         <ReturnType>System.Void</ReturnType>
256       </ReturnValue>
257       <Parameters>
258         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
259         <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
260       </Parameters>
261       <Docs>
262         <param name="serializationInfo">To be added.</param>
263         <param name="streamingContext">To be added.</param>
264         <summary>To be added.</summary>
265         <remarks>To be added.</remarks>
266       </Docs>
267     </Member>
268     <Member MemberName="GetRequestStream">
269       <MemberSignature Language="C#" Value="public override System.IO.Stream GetRequestStream ();" />
270       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IO.Stream GetRequestStream() cil managed" />
271       <MemberType>Method</MemberType>
272       <AssemblyInfo>
273         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
274         <AssemblyVersion>2.0.0.0</AssemblyVersion>
275         <AssemblyVersion>4.0.0.0</AssemblyVersion>
276       </AssemblyInfo>
277       <ReturnValue>
278         <ReturnType>System.IO.Stream</ReturnType>
279       </ReturnValue>
280       <Parameters />
281       <Docs>
282         <summary>To be added</summary>
283         <returns>To be added: an object of type 'IO.Stream'</returns>
284         <remarks>To be added</remarks>
285       </Docs>
286     </Member>
287     <Member MemberName="GetResponse">
288       <MemberSignature Language="C#" Value="public override System.Net.WebResponse GetResponse ();" />
289       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.WebResponse GetResponse() cil managed" />
290       <MemberType>Method</MemberType>
291       <AssemblyInfo>
292         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
293         <AssemblyVersion>2.0.0.0</AssemblyVersion>
294         <AssemblyVersion>4.0.0.0</AssemblyVersion>
295       </AssemblyInfo>
296       <ReturnValue>
297         <ReturnType>System.Net.WebResponse</ReturnType>
298       </ReturnValue>
299       <Parameters />
300       <Docs>
301         <summary>To be added</summary>
302         <returns>To be added: an object of type 'WebResponse'</returns>
303         <remarks>To be added</remarks>
304       </Docs>
305     </Member>
306     <Member MemberName="Headers">
307       <MemberSignature Language="C#" Value="public override System.Net.WebHeaderCollection Headers { get; }" />
308       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.WebHeaderCollection Headers" />
309       <MemberType>Property</MemberType>
310       <AssemblyInfo>
311         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
312         <AssemblyVersion>2.0.0.0</AssemblyVersion>
313         <AssemblyVersion>4.0.0.0</AssemblyVersion>
314       </AssemblyInfo>
315       <ReturnValue>
316         <ReturnType>System.Net.WebHeaderCollection</ReturnType>
317       </ReturnValue>
318       <Docs>
319         <summary>To be added</summary>
320         <value>To be added: an object of type 'WebHeaderCollection'</value>
321         <remarks>To be added</remarks>
322       </Docs>
323     </Member>
324     <Member MemberName="Method">
325       <MemberSignature Language="C#" Value="public override string Method { get; set; }" />
326       <MemberSignature Language="ILAsm" Value=".property instance string Method" />
327       <MemberType>Property</MemberType>
328       <AssemblyInfo>
329         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
330         <AssemblyVersion>2.0.0.0</AssemblyVersion>
331         <AssemblyVersion>4.0.0.0</AssemblyVersion>
332       </AssemblyInfo>
333       <ReturnValue>
334         <ReturnType>System.String</ReturnType>
335       </ReturnValue>
336       <Parameters>
337       </Parameters>
338       <Docs>
339         <summary>To be added</summary>
340         <value>To be added: an object of type 'string'</value>
341         <remarks>To be added</remarks>
342       </Docs>
343     </Member>
344     <Member MemberName="PreAuthenticate">
345       <MemberSignature Language="C#" Value="public override bool PreAuthenticate { get; set; }" />
346       <MemberSignature Language="ILAsm" Value=".property instance bool PreAuthenticate" />
347       <MemberType>Property</MemberType>
348       <AssemblyInfo>
349         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
350         <AssemblyVersion>2.0.0.0</AssemblyVersion>
351         <AssemblyVersion>4.0.0.0</AssemblyVersion>
352       </AssemblyInfo>
353       <ReturnValue>
354         <ReturnType>System.Boolean</ReturnType>
355       </ReturnValue>
356       <Parameters>
357       </Parameters>
358       <Docs>
359         <summary>To be added</summary>
360         <value>To be added: an object of type 'bool'</value>
361         <remarks>To be added</remarks>
362       </Docs>
363     </Member>
364     <Member MemberName="Proxy">
365       <MemberSignature Language="C#" Value="public override System.Net.IWebProxy Proxy { get; set; }" />
366       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.IWebProxy Proxy" />
367       <MemberType>Property</MemberType>
368       <AssemblyInfo>
369         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
370         <AssemblyVersion>2.0.0.0</AssemblyVersion>
371         <AssemblyVersion>4.0.0.0</AssemblyVersion>
372       </AssemblyInfo>
373       <ReturnValue>
374         <ReturnType>System.Net.IWebProxy</ReturnType>
375       </ReturnValue>
376       <Parameters>
377       </Parameters>
378       <Docs>
379         <summary>To be added</summary>
380         <value>To be added: an object of type 'IWebProxy'</value>
381         <remarks>To be added</remarks>
382       </Docs>
383     </Member>
384     <Member MemberName="RequestUri">
385       <MemberSignature Language="C#" Value="public override Uri RequestUri { get; }" />
386       <MemberSignature Language="ILAsm" Value=".property instance class System.Uri RequestUri" />
387       <MemberType>Property</MemberType>
388       <AssemblyInfo>
389         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
390         <AssemblyVersion>2.0.0.0</AssemblyVersion>
391         <AssemblyVersion>4.0.0.0</AssemblyVersion>
392       </AssemblyInfo>
393       <ReturnValue>
394         <ReturnType>System.Uri</ReturnType>
395       </ReturnValue>
396       <Docs>
397         <summary>To be added</summary>
398         <value>To be added: an object of type 'Uri'</value>
399         <remarks>To be added</remarks>
400       </Docs>
401     </Member>
402     <Member MemberName="System.Runtime.Serialization.ISerializable.GetObjectData">
403       <MemberSignature Language="C#" Value="void ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext);" />
404       <MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Runtime.Serialization.ISerializable.GetObjectData(class System.Runtime.Serialization.SerializationInfo serializationInfo, valuetype System.Runtime.Serialization.StreamingContext streamingContext) cil managed" />
405       <MemberType>Method</MemberType>
406       <AssemblyInfo>
407         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
408         <AssemblyVersion>2.0.0.0</AssemblyVersion>
409         <AssemblyVersion>4.0.0.0</AssemblyVersion>
410       </AssemblyInfo>
411       <ReturnValue>
412         <ReturnType>System.Void</ReturnType>
413       </ReturnValue>
414       <Parameters>
415         <Parameter Name="serializationInfo" Type="System.Runtime.Serialization.SerializationInfo" />
416         <Parameter Name="streamingContext" Type="System.Runtime.Serialization.StreamingContext" />
417       </Parameters>
418       <Docs>
419         <param name="serializationInfo">To be added.</param>
420         <param name="streamingContext">To be added.</param>
421         <summary>To be added.</summary>
422         <remarks>To be added.</remarks>
423       </Docs>
424     </Member>
425     <Member MemberName="Timeout">
426       <MemberSignature Language="C#" Value="public override int Timeout { get; set; }" />
427       <MemberSignature Language="ILAsm" Value=".property instance int32 Timeout" />
428       <MemberType>Property</MemberType>
429       <AssemblyInfo>
430         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
431         <AssemblyVersion>2.0.0.0</AssemblyVersion>
432         <AssemblyVersion>4.0.0.0</AssemblyVersion>
433       </AssemblyInfo>
434       <ReturnValue>
435         <ReturnType>System.Int32</ReturnType>
436       </ReturnValue>
437       <Parameters>
438       </Parameters>
439       <Docs>
440         <summary>To be added</summary>
441         <value>To be added: an object of type 'int'</value>
442         <remarks>To be added</remarks>
443       </Docs>
444     </Member>
445     <Member MemberName="UseDefaultCredentials">
446       <MemberSignature Language="C#" Value="public override bool UseDefaultCredentials { get; set; }" />
447       <MemberSignature Language="ILAsm" Value=".property instance bool UseDefaultCredentials" />
448       <MemberType>Property</MemberType>
449       <AssemblyInfo>
450         <AssemblyVersion>2.0.0.0</AssemblyVersion>
451         <AssemblyVersion>4.0.0.0</AssemblyVersion>
452       </AssemblyInfo>
453       <ReturnValue>
454         <ReturnType>System.Boolean</ReturnType>
455       </ReturnValue>
456       <Docs>
457         <summary>To be added.</summary>
458         <value>To be added.</value>
459         <remarks>To be added.</remarks>
460       </Docs>
461     </Member>
462   </Members>
463 </Type>