2008-12-08 Atsushi Enomoto <atsushi@ximian.com>
[mono.git] / mcs / class / corlib / Documentation / en / System.IO.IsolatedStorage / IsolatedStorageFile.xml
1 <Type Name="IsolatedStorageFile" FullName="System.IO.IsolatedStorage.IsolatedStorageFile">
2   <TypeSignature Maintainer="auto" Language="C#" Value="public sealed class IsolatedStorageFile : System.IO.IsolatedStorage.IsolatedStorage, IDisposable" />
3   <AssemblyInfo>
4     <AssemblyName>mscorlib</AssemblyName>
5     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
8   </AssemblyInfo>
9   <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>
10   <Base>
11     <BaseTypeName>System.IO.IsolatedStorage.IsolatedStorage</BaseTypeName>
12   </Base>
13   <Interfaces>
14     <Interface>
15       <InterfaceName>System.IDisposable</InterfaceName>
16     </Interface>
17   </Interfaces>
18   <Docs>
19     <summary>To be added</summary>
20     <remarks>To be added</remarks>
21   </Docs>
22   <Members>
23     <Member MemberName="Close">
24       <MemberSignature Language="C#" Value="public void Close ();" />
25       <MemberType>Method</MemberType>
26       <ReturnValue>
27         <ReturnType>System.Void</ReturnType>
28       </ReturnValue>
29       <Parameters />
30       <Docs>
31         <summary>To be added</summary>
32         <remarks>To be added</remarks>
33       </Docs>
34       <AssemblyInfo>
35         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
36         <AssemblyVersion>2.0.0.0</AssemblyVersion>
37       </AssemblyInfo>
38     </Member>
39     <Member MemberName="CreateDirectory">
40       <MemberSignature Language="C#" Value="public void CreateDirectory (string dir);" />
41       <MemberType>Method</MemberType>
42       <ReturnValue>
43         <ReturnType>System.Void</ReturnType>
44       </ReturnValue>
45       <Parameters>
46         <Parameter Name="dir" Type="System.String" />
47       </Parameters>
48       <Docs>
49         <param name="dir">To be added: an object of type 'string'</param>
50         <summary>To be added</summary>
51         <remarks>To be added</remarks>
52       </Docs>
53       <AssemblyInfo>
54         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
55         <AssemblyVersion>2.0.0.0</AssemblyVersion>
56       </AssemblyInfo>
57     </Member>
58     <Member MemberName="CurrentSize">
59       <MemberSignature Language="C#" Value="public override ulong CurrentSize { get; }" />
60       <MemberType>Property</MemberType>
61       <Attributes>
62         <Attribute>
63           <AttributeName>System.CLSCompliant(false)</AttributeName>
64         </Attribute>
65       </Attributes>
66       <ReturnValue>
67         <ReturnType>System.UInt64</ReturnType>
68       </ReturnValue>
69       <Docs>
70         <summary>To be added.</summary>
71         <value>To be added.</value>
72         <remarks>To be added.</remarks>
73       </Docs>
74       <AssemblyInfo>
75         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
76         <AssemblyVersion>2.0.0.0</AssemblyVersion>
77       </AssemblyInfo>
78     </Member>
79     <Member MemberName="DeleteDirectory">
80       <MemberSignature Language="C#" Value="public void DeleteDirectory (string dir);" />
81       <MemberType>Method</MemberType>
82       <ReturnValue>
83         <ReturnType>System.Void</ReturnType>
84       </ReturnValue>
85       <Parameters>
86         <Parameter Name="dir" Type="System.String" />
87       </Parameters>
88       <Docs>
89         <param name="dir">To be added: an object of type 'string'</param>
90         <summary>To be added</summary>
91         <remarks>To be added</remarks>
92       </Docs>
93       <AssemblyInfo>
94         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
95         <AssemblyVersion>2.0.0.0</AssemblyVersion>
96       </AssemblyInfo>
97     </Member>
98     <Member MemberName="DeleteFile">
99       <MemberSignature Language="C#" Value="public void DeleteFile (string file);" />
100       <MemberType>Method</MemberType>
101       <ReturnValue>
102         <ReturnType>System.Void</ReturnType>
103       </ReturnValue>
104       <Parameters>
105         <Parameter Name="file" Type="System.String" />
106       </Parameters>
107       <Docs>
108         <param name="file">To be added: an object of type 'string'</param>
109         <summary>To be added</summary>
110         <remarks>To be added</remarks>
111       </Docs>
112       <AssemblyInfo>
113         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
114         <AssemblyVersion>2.0.0.0</AssemblyVersion>
115       </AssemblyInfo>
116     </Member>
117     <Member MemberName="Dispose">
118       <MemberSignature Language="C#" Value="public void Dispose ();" />
119       <MemberType>Method</MemberType>
120       <ReturnValue>
121         <ReturnType>System.Void</ReturnType>
122       </ReturnValue>
123       <Parameters />
124       <Docs>
125         <summary>To be added</summary>
126         <remarks>To be added</remarks>
127       </Docs>
128       <AssemblyInfo>
129         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
130         <AssemblyVersion>2.0.0.0</AssemblyVersion>
131       </AssemblyInfo>
132     </Member>
133     <Member MemberName="Finalize">
134       <MemberSignature Language="C#" Value="~IsolatedStorageFile ();" />
135       <MemberType>Method</MemberType>
136       <ReturnValue>
137         <ReturnType>System.Void</ReturnType>
138       </ReturnValue>
139       <Parameters />
140       <Docs>
141         <summary>To be added.</summary>
142         <remarks>To be added.</remarks>
143       </Docs>
144       <AssemblyInfo>
145         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
146         <AssemblyVersion>2.0.0.0</AssemblyVersion>
147       </AssemblyInfo>
148     </Member>
149     <Member MemberName="GetDirectoryNames">
150       <MemberSignature Language="C#" Value="public string[] GetDirectoryNames (string searchPattern);" />
151       <MemberType>Method</MemberType>
152       <ReturnValue>
153         <ReturnType>System.String[]</ReturnType>
154       </ReturnValue>
155       <Parameters>
156         <Parameter Name="searchPattern" Type="System.String" />
157       </Parameters>
158       <Docs>
159         <param name="searchPattern">To be added: an object of type 'string'</param>
160         <summary>To be added</summary>
161         <returns>To be added: an object of type 'string []'</returns>
162         <remarks>To be added</remarks>
163       </Docs>
164       <AssemblyInfo>
165         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
166         <AssemblyVersion>2.0.0.0</AssemblyVersion>
167       </AssemblyInfo>
168     </Member>
169     <Member MemberName="GetEnumerator">
170       <MemberSignature Language="C#" Value="public static System.Collections.IEnumerator GetEnumerator (System.IO.IsolatedStorage.IsolatedStorageScope scope);" />
171       <MemberType>Method</MemberType>
172       <ReturnValue>
173         <ReturnType>System.Collections.IEnumerator</ReturnType>
174       </ReturnValue>
175       <Parameters>
176         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
177       </Parameters>
178       <Docs>
179         <param name="scope">To be added: an object of type 'IsolatedStorageScope'</param>
180         <summary>To be added</summary>
181         <returns>To be added: an object of type 'Collections.IEnumerator'</returns>
182         <remarks>To be added</remarks>
183       </Docs>
184       <AssemblyInfo>
185         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
186         <AssemblyVersion>2.0.0.0</AssemblyVersion>
187       </AssemblyInfo>
188     </Member>
189     <Member MemberName="GetFileNames">
190       <MemberSignature Language="C#" Value="public string[] GetFileNames (string searchPattern);" />
191       <MemberType>Method</MemberType>
192       <ReturnValue>
193         <ReturnType>System.String[]</ReturnType>
194       </ReturnValue>
195       <Parameters>
196         <Parameter Name="searchPattern" Type="System.String" />
197       </Parameters>
198       <Docs>
199         <param name="searchPattern">To be added: an object of type 'string'</param>
200         <summary>To be added</summary>
201         <returns>To be added: an object of type 'string []'</returns>
202         <remarks>To be added</remarks>
203       </Docs>
204       <AssemblyInfo>
205         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
206         <AssemblyVersion>2.0.0.0</AssemblyVersion>
207       </AssemblyInfo>
208     </Member>
209     <Member MemberName="GetMachineStoreForApplication">
210       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetMachineStoreForApplication ();" />
211       <MemberType>Method</MemberType>
212       <ReturnValue>
213         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
214       </ReturnValue>
215       <Parameters />
216       <Docs>
217         <summary>To be added.</summary>
218         <returns>To be added.</returns>
219         <remarks>To be added.</remarks>
220         <since version=".NET 2.0" />
221       </Docs>
222       <AssemblyInfo>
223         <AssemblyVersion>2.0.0.0</AssemblyVersion>
224       </AssemblyInfo>
225     </Member>
226     <Member MemberName="GetMachineStoreForAssembly">
227       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetMachineStoreForAssembly ();" />
228       <MemberType>Method</MemberType>
229       <ReturnValue>
230         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
231       </ReturnValue>
232       <Parameters />
233       <Docs>
234         <summary>To be added.</summary>
235         <returns>To be added.</returns>
236         <remarks>To be added.</remarks>
237         <since version=".NET 2.0" />
238       </Docs>
239       <AssemblyInfo>
240         <AssemblyVersion>2.0.0.0</AssemblyVersion>
241       </AssemblyInfo>
242     </Member>
243     <Member MemberName="GetMachineStoreForDomain">
244       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetMachineStoreForDomain ();" />
245       <MemberType>Method</MemberType>
246       <ReturnValue>
247         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
248       </ReturnValue>
249       <Parameters />
250       <Docs>
251         <summary>To be added.</summary>
252         <returns>To be added.</returns>
253         <remarks>To be added.</remarks>
254         <since version=".NET 2.0" />
255       </Docs>
256       <AssemblyInfo>
257         <AssemblyVersion>2.0.0.0</AssemblyVersion>
258       </AssemblyInfo>
259     </Member>
260     <Member MemberName="GetPermission">
261       <MemberSignature Language="C#" Value="protected override System.Security.Permissions.IsolatedStoragePermission GetPermission (System.Security.PermissionSet ps);" />
262       <MemberType>Method</MemberType>
263       <ReturnValue>
264         <ReturnType>System.Security.Permissions.IsolatedStoragePermission</ReturnType>
265       </ReturnValue>
266       <Parameters>
267         <Parameter Name="ps" Type="System.Security.PermissionSet" />
268       </Parameters>
269       <Docs>
270         <param name="ps">To be added.</param>
271         <summary>To be added.</summary>
272         <returns>To be added.</returns>
273         <remarks>To be added.</remarks>
274       </Docs>
275       <AssemblyInfo>
276         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
277         <AssemblyVersion>2.0.0.0</AssemblyVersion>
278       </AssemblyInfo>
279     </Member>
280     <Member MemberName="GetStore">
281       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetStore (System.IO.IsolatedStorage.IsolatedStorageScope scope, object applicationIdentity);" />
282       <MemberType>Method</MemberType>
283       <ReturnValue>
284         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
285       </ReturnValue>
286       <Parameters>
287         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
288         <Parameter Name="applicationIdentity" Type="System.Object" />
289       </Parameters>
290       <Docs>
291         <param name="scope">To be added.</param>
292         <param name="applicationIdentity">To be added.</param>
293         <summary>To be added.</summary>
294         <returns>To be added.</returns>
295         <remarks>To be added.</remarks>
296         <since version=".NET 2.0" />
297       </Docs>
298       <AssemblyInfo>
299         <AssemblyVersion>2.0.0.0</AssemblyVersion>
300       </AssemblyInfo>
301     </Member>
302     <Member MemberName="GetStore">
303       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetStore (System.IO.IsolatedStorage.IsolatedStorageScope scope, Type applicationEvidenceType);" />
304       <MemberType>Method</MemberType>
305       <ReturnValue>
306         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
307       </ReturnValue>
308       <Parameters>
309         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
310         <Parameter Name="applicationEvidenceType" Type="System.Type" />
311       </Parameters>
312       <Docs>
313         <param name="scope">To be added.</param>
314         <param name="applicationEvidenceType">To be added.</param>
315         <summary>To be added.</summary>
316         <returns>To be added.</returns>
317         <remarks>To be added.</remarks>
318         <since version=".NET 2.0" />
319       </Docs>
320       <AssemblyInfo>
321         <AssemblyVersion>2.0.0.0</AssemblyVersion>
322       </AssemblyInfo>
323     </Member>
324     <Member MemberName="GetStore">
325       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetStore (System.IO.IsolatedStorage.IsolatedStorageScope scope, object domainIdentity, object assemblyIdentity);" />
326       <MemberType>Method</MemberType>
327       <ReturnValue>
328         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
329       </ReturnValue>
330       <Parameters>
331         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
332         <Parameter Name="domainIdentity" Type="System.Object" />
333         <Parameter Name="assemblyIdentity" Type="System.Object" />
334       </Parameters>
335       <Docs>
336         <param name="scope">To be added: an object of type 'IsolatedStorageScope'</param>
337         <param name="domainIdentity">To be added: an object of type 'object'</param>
338         <param name="assemblyIdentity">To be added: an object of type 'object'</param>
339         <summary>To be added</summary>
340         <returns>To be added: an object of type 'IsolatedStorageFile'</returns>
341         <remarks>To be added</remarks>
342       </Docs>
343       <AssemblyInfo>
344         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
345         <AssemblyVersion>2.0.0.0</AssemblyVersion>
346       </AssemblyInfo>
347     </Member>
348     <Member MemberName="GetStore">
349       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetStore (System.IO.IsolatedStorage.IsolatedStorageScope scope, Type domainEvidenceType, Type assemblyEvidenceType);" />
350       <MemberType>Method</MemberType>
351       <ReturnValue>
352         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
353       </ReturnValue>
354       <Parameters>
355         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
356         <Parameter Name="domainEvidenceType" Type="System.Type" />
357         <Parameter Name="assemblyEvidenceType" Type="System.Type" />
358       </Parameters>
359       <Docs>
360         <param name="scope">To be added: an object of type 'IsolatedStorageScope'</param>
361         <param name="domainEvidenceType">To be added: an object of type 'Type'</param>
362         <param name="assemblyEvidenceType">To be added: an object of type 'Type'</param>
363         <summary>To be added</summary>
364         <returns>To be added: an object of type 'IsolatedStorageFile'</returns>
365         <remarks>To be added</remarks>
366       </Docs>
367       <AssemblyInfo>
368         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
369         <AssemblyVersion>2.0.0.0</AssemblyVersion>
370       </AssemblyInfo>
371     </Member>
372     <Member MemberName="GetStore">
373       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetStore (System.IO.IsolatedStorage.IsolatedStorageScope scope, System.Security.Policy.Evidence domainEvidence, Type domainEvidenceType, System.Security.Policy.Evidence assemblyEvidence, Type assemblyEvidenceType);" />
374       <MemberType>Method</MemberType>
375       <ReturnValue>
376         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
377       </ReturnValue>
378       <Parameters>
379         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
380         <Parameter Name="domainEvidence" Type="System.Security.Policy.Evidence" />
381         <Parameter Name="domainEvidenceType" Type="System.Type" />
382         <Parameter Name="assemblyEvidence" Type="System.Security.Policy.Evidence" />
383         <Parameter Name="assemblyEvidenceType" Type="System.Type" />
384       </Parameters>
385       <Docs>
386         <param name="scope">To be added: an object of type 'IsolatedStorageScope'</param>
387         <param name="domainEvidence">To be added: an object of type 'Security.Policy.Evidence'</param>
388         <param name="domainEvidenceType">To be added: an object of type 'Type'</param>
389         <param name="assemblyEvidence">To be added: an object of type 'Security.Policy.Evidence'</param>
390         <param name="assemblyEvidenceType">To be added: an object of type 'Type'</param>
391         <summary>To be added</summary>
392         <returns>To be added: an object of type 'IsolatedStorageFile'</returns>
393         <remarks>To be added</remarks>
394       </Docs>
395       <AssemblyInfo>
396         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
397         <AssemblyVersion>2.0.0.0</AssemblyVersion>
398       </AssemblyInfo>
399     </Member>
400     <Member MemberName="GetUserStoreForApplication">
401       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetUserStoreForApplication ();" />
402       <MemberType>Method</MemberType>
403       <ReturnValue>
404         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
405       </ReturnValue>
406       <Parameters />
407       <Docs>
408         <summary>To be added.</summary>
409         <returns>To be added.</returns>
410         <remarks>To be added.</remarks>
411         <since version=".NET 2.0" />
412       </Docs>
413       <AssemblyInfo>
414         <AssemblyVersion>2.0.0.0</AssemblyVersion>
415       </AssemblyInfo>
416     </Member>
417     <Member MemberName="GetUserStoreForAssembly">
418       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetUserStoreForAssembly ();" />
419       <MemberType>Method</MemberType>
420       <ReturnValue>
421         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
422       </ReturnValue>
423       <Parameters />
424       <Docs>
425         <summary>To be added</summary>
426         <returns>To be added: an object of type 'IsolatedStorageFile'</returns>
427         <remarks>To be added</remarks>
428       </Docs>
429       <AssemblyInfo>
430         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
431         <AssemblyVersion>2.0.0.0</AssemblyVersion>
432       </AssemblyInfo>
433     </Member>
434     <Member MemberName="GetUserStoreForDomain">
435       <MemberSignature Language="C#" Value="public static System.IO.IsolatedStorage.IsolatedStorageFile GetUserStoreForDomain ();" />
436       <MemberType>Method</MemberType>
437       <ReturnValue>
438         <ReturnType>System.IO.IsolatedStorage.IsolatedStorageFile</ReturnType>
439       </ReturnValue>
440       <Parameters />
441       <Docs>
442         <summary>To be added</summary>
443         <returns>To be added: an object of type 'IsolatedStorageFile'</returns>
444         <remarks>To be added</remarks>
445       </Docs>
446       <AssemblyInfo>
447         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
448         <AssemblyVersion>2.0.0.0</AssemblyVersion>
449       </AssemblyInfo>
450     </Member>
451     <Member MemberName="MaximumSize">
452       <MemberSignature Language="C#" Value="public override ulong MaximumSize { get; }" />
453       <MemberType>Property</MemberType>
454       <Attributes>
455         <Attribute>
456           <AttributeName>System.CLSCompliant(false)</AttributeName>
457         </Attribute>
458       </Attributes>
459       <ReturnValue>
460         <ReturnType>System.UInt64</ReturnType>
461       </ReturnValue>
462       <Docs>
463         <summary>To be added.</summary>
464         <value>To be added.</value>
465         <remarks>To be added.</remarks>
466       </Docs>
467       <AssemblyInfo>
468         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
469         <AssemblyVersion>2.0.0.0</AssemblyVersion>
470       </AssemblyInfo>
471     </Member>
472     <Member MemberName="Remove">
473       <MemberSignature Language="C#" Value="public override void Remove ();" />
474       <MemberType>Method</MemberType>
475       <ReturnValue>
476         <ReturnType>System.Void</ReturnType>
477       </ReturnValue>
478       <Parameters />
479       <Docs>
480         <summary>To be added.</summary>
481         <remarks>To be added.</remarks>
482       </Docs>
483       <AssemblyInfo>
484         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
485         <AssemblyVersion>2.0.0.0</AssemblyVersion>
486       </AssemblyInfo>
487     </Member>
488     <Member MemberName="Remove">
489       <MemberSignature Language="C#" Value="public static void Remove (System.IO.IsolatedStorage.IsolatedStorageScope scope);" />
490       <MemberType>Method</MemberType>
491       <ReturnValue>
492         <ReturnType>System.Void</ReturnType>
493       </ReturnValue>
494       <Parameters>
495         <Parameter Name="scope" Type="System.IO.IsolatedStorage.IsolatedStorageScope" />
496       </Parameters>
497       <Docs>
498         <param name="scope">To be added: an object of type 'IsolatedStorageScope'</param>
499         <summary>To be added</summary>
500         <remarks>To be added</remarks>
501       </Docs>
502       <AssemblyInfo>
503         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
504         <AssemblyVersion>2.0.0.0</AssemblyVersion>
505       </AssemblyInfo>
506     </Member>
507   </Members>
508   <Attributes>
509     <Attribute>
510       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
511     </Attribute>
512   </Attributes>
513 </Type>