mcs/class/Mono.Posix/Documentation/en/Mono.Unix/StdioFileStream.xml

   1 <Type Name="StdioFileStream" FullName="Mono.Unix.StdioFileStream">
   2   <TypeSignature Language="C#" Value="public class StdioFileStream : System.IO.Stream" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Posix</AssemblyName>
   5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
   9   <Base>
  10     <BaseTypeName>System.IO.Stream</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <summary>A <see cref="T:System.IO.Stream" /> wrapper over the <c>FILE</c>
  15     type.</summary>
  16     <remarks>
  17       <para>
  18         <see cref="T:Mono.Unix.StdioFileStream" /> is used for reading and
  19         writing files on a file system and interoperating with the standard
  20         ANSI/ISO C <c>FILE</c> pointer data type.
  21       </para>
  22       <para>
  23         <see cref="T:Mono.Unix.StdioFileStream" /> objects support
  24         random access to files using the
  25         <see cref="M:System.IO.Stream.Seek(System.Int64,System.IO.SeekOrigin)" />
  26         method, and the
  27         <see cref="P:System.IO.Stream.CanSeek" /> properties of
  28         <see cref="T:Mono.Unix.StdioFileStream" /> instances
  29         encapsulating files are set to <see langword="true" />.
  30         The
  31         <see cref="M:System.IO.Stream.Seek(System.Int64,System.IO.SeekOrigin)" />
  32         method allows the read/write position to be moved to any position
  33         within the file. This is done with byte offset reference point
  34         parameters. The byte offset is relative to the seek reference point,
  35         which can be the beginning, the current position, or the end of the
  36         underlying file, as represented by the three values of the
  37         <see cref="T:System.IO.SeekOrigin" /> enumeration.
  38       </para>
  39       <para>
  40         If a <see cref="T:Mono.Unix.StdioFileStream" /> encapsulates a
  41         device that does not support seeking, its
  42         <see cref="P:System.IO.FileStream.CanSeek" /> property is
  43         <see langword="false" />.
  44         <block subset="none" type="note">
  45           For additional information, see
  46           <see cref="P:System.IO.Stream.CanSeek" />.
  47         </block></para>
  48       <example>
  49         <para>
  50           The following example demonstrates the use of a
  51           <see cref="T:Mono.Unix.StdioFileStream" /> object.
  52         </para>
  53         <code lang="C#">using System;
  54 using System.IO;
  55 using Mono.Unix;
  56
  57 class Directory {
  58    public static void Main(String[] args) {
  59       StdioFileStream fs = new StdioFileStream ("log.txt", "ab");
  60       StreamWriter w = new StreamWriter(fs);
  61
  62       Log ("Test1", w);
  63       Log ("Test2", w);
  64
  65       w.Close(); // Close the writer and underlying file.
  66
  67       fs = new StdioFileStream("log.txt", "rb");
  68
  69       StreamReader r = new StreamReader(fs);
  70       r.BaseStream.Seek(0, SeekOrigin.Begin);
  71       DumpLog (r);
  72    }
  73
  74    public static void Log (String logMessage, StreamWriter w) {
  75       w.Write("Log Entry : ");
  76       w.WriteLine("{0} {1}", DateTime.Now.ToLongTimeString(), DateTime.Now.ToLongDateString());
  77       w.WriteLine(":");
  78       w.WriteLine(":{0}", logMessage);
  79       w.WriteLine ("-------------------------------");
  80       w.Flush();
  81    }
  82
  83    public static void DumpLog (StreamReader r) {
  84       while (r.Peek() &gt; -1) { // While not at the end of the file, write to standard output.
  85         Console.WriteLine(r.ReadLine());
  86       }
  87
  88       r.Close();
  89    }
  90 }
  91 </code>
  92         <para>Some example output is </para>
  93         <c>
  94           <para>Log Entry : 9:26:21 AM Friday, July 06, 2001</para>
  95           <para>:</para>
  96           <para>:Test1</para>
  97           <para>-------------------------------</para>
  98           <para>Log Entry : 9:26:21 AM Friday, July 06, 2001</para>
  99           <para>:</para>
 100           <para>:Test2</para>
 101           <para>-------------------------------</para>
 102         </c>
 103       </example>
 104     </remarks>
 105   </Docs>
 106   <Members>
 107     <Member MemberName=".ctor">
 108       <MemberSignature Language="C#" Value="public StdioFileStream (IntPtr fileStream);" />
 109       <MemberType>Constructor</MemberType>
 110       <Parameters>
 111         <Parameter Name="fileStream" Type="System.IntPtr" />
 112       </Parameters>
 113       <Docs>
 114         <param name="fileStream">
 115           A <see cref="T:System.IntPtr" /> containing a <c>FILE</c> pointer.
 116         </param>
 117         <summary>Creates a <see cref="T:Mono.Unix.StdioFileStream" /> type,
 118         wrapping the existing unmanaged <c>FILE</c> pointer
 119         <paramref name="fileStream" />.</summary>
 120         <remarks>
 121           <para>By default, <paramref name="fileStream" /> is owned by the
 122           created <see cref="T:Mono.Unix.StdioFileStream" /> instance.</para>
 123         </remarks>
 124         <exception cref="T:System.ArgumentException">
 125           <paramref name="fileStream" /> is an invalid <c>FILE</c> pointer.
 126         </exception>
 127         <altmember cref="C:Mono.Unix.StdioFileStream(IntPtr, bool)" />
 128       </Docs>
 129       <AssemblyInfo>
 130         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 131         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 132       </AssemblyInfo>
 133     </Member>
 134     <Member MemberName=".ctor">
 135       <MemberSignature Language="C#" Value="public StdioFileStream (string path);" />
 136       <MemberType>Constructor</MemberType>
 137       <Parameters>
 138         <Parameter Name="path" Type="System.String" />
 139       </Parameters>
 140       <Docs>
 141         <param name="path">A <see cref="T:System.String" /> containing the file name to open.</param>
 142         <summary>Opens <paramref name="path" /> for reading.</summary>
 143         <remarks>
 144         </remarks>
 145         <exception cref="T:System.ArgumentNullException">
 146           <paramref name="path" /> or <paramref name="mode" /> is
 147           <see langword="null" />.
 148         </exception>
 149         <exception cref="T:System.ArgumentException">
 150           <paramref name="path" /> is a <c>0</c>-length string.
 151         </exception>
 152         <exception cref="T:System.IO.DirectoryNotFoundException">
 153           <paramref name="path" /> could not be opened.
 154         </exception>
 155       </Docs>
 156       <AssemblyInfo>
 157         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 158         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 159       </AssemblyInfo>
 160     </Member>
 161     <Member MemberName=".ctor">
 162       <MemberSignature Language="C#" Value="public StdioFileStream (IntPtr fileStream, bool ownsHandle);" />
 163       <MemberType>Constructor</MemberType>
 164       <Parameters>
 165         <Parameter Name="fileStream" Type="System.IntPtr" />
 166         <Parameter Name="ownsHandle" Type="System.Boolean" />
 167       </Parameters>
 168       <Docs>
 169         <param name="fileStream">A <see cref="T:System.IntPtr" /> containing a <c>FILE</c> pointer</param>
 170         <param name="ownsHandle">A <see cref="T:System.Boolean" /> specifying whether or not the created
 171           <see cref="T:Mono.Unix.StdioFileStream" /> instance "owns"
 172           <paramref name="fileStream" />.</param>
 173         <summary>Creates a <see cref="T:Mono.Unix.StdioFileStream" /> type,
 174         wrapping the existing unmanaged <c>FILE</c> pointer
 175         <paramref name="fileStream" />.</summary>
 176         <remarks>If <paramref name="ownsHandle" /> is <see langword="true" />,
 177         then <paramref name="fileStream" /> will be closed via
 178         <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> when
 179         <see cref="M:Mono.Unix.StdioFileStream.Close" /> is invoked (which is
 180         also called from the finalizer and from the
 181         <see cref="T:System.IDisposable" /> implementation).  Otherwise,
 182         <paramref name="fileStream" /> will only be flushed on
 183         <see cref="M:Mono.Unix.StdioFileStream.Close" /> and not actually
 184         closed.</remarks>
 185         <exception cref="T:System.ArgumentException">
 186           <paramref name="fileStream" /> is an invalid <c>FILE</c> pointer.
 187         </exception>
 188       </Docs>
 189       <AssemblyInfo>
 190         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 191         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 192       </AssemblyInfo>
 193     </Member>
 194     <Member MemberName=".ctor">
 195       <MemberSignature Language="C#" Value="public StdioFileStream (IntPtr fileStream, System.IO.FileAccess access);" />
 196       <MemberType>Constructor</MemberType>
 197       <Parameters>
 198         <Parameter Name="fileStream" Type="System.IntPtr" />
 199         <Parameter Name="access" Type="System.IO.FileAccess" />
 200       </Parameters>
 201       <Docs>
 202         <param name="fileStream">A <see cref="T:System.IntPtr" /> containing a <c>FILE</c> pointer</param>
 203         <param name="access">A <see cref="T:System.IO.FileAccess" /> value
 204           that determins how the file may be accessed by the
 205           <see cref="T:Mono.Unix.StdioFileStream" /> object.  This parameter is
 206           used to specify the initial values of the
 207           <see cref="P:System.IO.Stream.CanRead" /> and
 208           <see cref="P:System.IO.Stream.CanWrite" /> properties.</param>
 209         <summary>Creates a <see cref="T:Mono.Unix.StdioFileStream" /> type,
 210         wrapping the existing unmanaged <c>FILE</c> pointer
 211         <paramref name="fileStream" /> with the specified file
 212         <paramref name="access" />.</summary>
 213         <remarks>
 214           <para>By default, <paramref name="fileStream" /> is owned by the
 215           created <see cref="T:Mono.Unix.StdioFileStream" /> instance.</para>
 216         </remarks>
 217         <exception cref="T:System.ArgumentException">
 218           <paramref name="fileStream" /> is an invalid <c>FILE</c> pointer.
 219         </exception>
 220         <altmember cref="C:Mono.Unix.StdioFileStream(IntPtr, System.IO.FileAccess, bool)" />
 221       </Docs>
 222       <AssemblyInfo>
 223         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 224         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 225       </AssemblyInfo>
 226     </Member>
 227     <Member MemberName=".ctor">
 228       <MemberSignature Language="C#" Value="public StdioFileStream (string path, System.IO.FileAccess access);" />
 229       <MemberType>Constructor</MemberType>
 230       <Parameters>
 231         <Parameter Name="path" Type="System.String" />
 232         <Parameter Name="access" Type="System.IO.FileAccess" />
 233       </Parameters>
 234       <Docs>
 235         <param name="path">A <see cref="T:System.String" /> containing the file name to open.</param>
 236         <param name="access">A <see cref="T:System.IO.FileAccess" /> value
 237         that determins how the file may be accessed by the
 238         <see cref="T:Mono.Unix.StdioFileStream" /> object.  This parameter is
 239         used to specify the initial values of the
 240         <see cref="P:System.IO.Stream.CanRead" /> and
 241         <see cref="P:System.IO.Stream.CanWrite" /> properties.</param>
 242         <summary>Opens <paramref name="path" /> with the specified file access
 243         <paramref name="access" />.</summary>
 244         <remarks>
 245         </remarks>
 246         <exception cref="T:System.ArgumentNullException">
 247           <paramref name="path" /> or <paramref name="mode" /> is
 248           <see langword="null" />.
 249         </exception>
 250         <exception cref="T:System.ArgumentException">
 251           <paramref name="path" /> is a <c>0</c>-length string.
 252         </exception>
 253         <exception cref="T:System.IO.DirectoryNotFoundException">
 254           <paramref name="path" /> could not be opened.
 255         </exception>
 256         <exception cref="T:System.ArgumentOutOfRangeException">
 257           <paramref name="access" /> is not one of
 258           <see cref="F:System.IO.FileAccess.Read" />,
 259           <see cref="F:System.IO.FileAccess.Write" />, or
 260           <see cref="F:System.IO.FileAccess.ReadWrite" />.
 261         </exception>
 262       </Docs>
 263       <AssemblyInfo>
 264         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 265         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 266       </AssemblyInfo>
 267     </Member>
 268     <Member MemberName=".ctor">
 269       <MemberSignature Language="C#" Value="public StdioFileStream (string path, System.IO.FileMode mode);" />
 270       <MemberType>Constructor</MemberType>
 271       <Parameters>
 272         <Parameter Name="path" Type="System.String" />
 273         <Parameter Name="mode" Type="System.IO.FileMode" />
 274       </Parameters>
 275       <Docs>
 276         <param name="path">A <see cref="T:System.String" /> containing the file name to open.</param>
 277         <param name="mode">A <see cref="T:System.IO.FileMode" /> value that
 278         determines how to open or create the file.</param>
 279         <summary>Opens <paramref name="path" /> with the specified file mode
 280         <paramref name="mode" />.</summary>
 281         <remarks>
 282         </remarks>
 283         <exception cref="T:System.ArgumentNullException">
 284           <paramref name="path" /> or <paramref name="mode" /> is
 285           <see langword="null" />.
 286         </exception>
 287         <exception cref="T:System.ArgumentException">
 288           <paramref name="path" /> is a <c>0</c>-length string.
 289         </exception>
 290         <exception cref="T:System.IO.DirectoryNotFoundException">
 291           <paramref name="path" /> could not be opened.
 292         </exception>
 293         <exception cref="T:System.IO.IOException">
 294           <paramref name="path" /> exists and
 295           <see cref="F:System.IO.FileMode.CreateNew" /> was specified.
 296         </exception>
 297         <exception cref="T:System.IO.FileNotFoundException">
 298           <paramref name="path" /> doesn't exist and
 299           <see cref="F:System.IO.FileMode.Open" /> was specified.
 300         </exception>
 301       </Docs>
 302       <AssemblyInfo>
 303         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 304         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 305       </AssemblyInfo>
 306     </Member>
 307     <Member MemberName=".ctor">
 308       <MemberSignature Language="C#" Value="public StdioFileStream (string path, string mode);" />
 309       <MemberType>Constructor</MemberType>
 310       <Parameters>
 311         <Parameter Name="path" Type="System.String" />
 312         <Parameter Name="mode" Type="System.String" />
 313       </Parameters>
 314       <Docs>
 315         <param name="path">A <see cref="T:System.String" /> containing the file name to open.</param>
 316         <param name="mode">A <see cref="T:System.String" /> specifying how to access <paramref name="path" />.</param>
 317         <summary>Opens <paramref name="path" /> with the specified
 318         <paramref name="mode" />.</summary>
 319         <remarks>
 320           <para>The argument <paramref name="mode" /> points to a string
 321           beginning with one of the following sequences (Additional characters
 322           may follow these sequences.):</para>
 323           <list type="table">
 324             <listheader>
 325               <term>
 326                 <paramref name="mode" />
 327               </term>
 328               <description>Description</description>
 329             </listheader>
 330             <item>
 331               <term>
 332                 <c>"r"</c>
 333               </term>
 334               <description> Open text file for reading.  The stream is positioned at the beginning of the file.</description>
 335             </item>
 336             <item>
 337               <term>
 338                 <c>"r+"</c>
 339               </term>
 340               <description>Open for reading and writing.  The stream is positioned at the beginning of the file.</description>
 341             </item>
 342             <item>
 343               <term>
 344                 <c>"w"</c>
 345               </term>
 346               <description>Truncate file to zero length or create text file for writing.  The stream is positioned at the beginning of the file.</description>
 347             </item>
 348             <item>
 349               <term>
 350                 <c>"w+"</c>
 351               </term>
 352               <description>Open for reading and writing.  The file is created if it does not exist, otherwise it is truncated.  The stream is positioned at the beginning of the file.</description>
 353             </item>
 354             <item>
 355               <term>
 356                 <c>"a"</c>
 357               </term>
 358               <description>Open for writing.  The file is created if it does not exist.  The stream is positioned at the end of the file.  Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:System.IO.Stream.Seek" /> call or similar.</description>
 359             </item>
 360             <item>
 361               <term>
 362                 <c>"a+"</c>
 363               </term>
 364               <description>Open for reading and writing.  The file is created if it does not exist.  The stream is positioned at the end of the file.  Subsequent writes to the file will always end up at the then current end of file, irrespective of any intervening <see cref="M:System.IO.Stream.Seek" /> or similar.</description>
 365             </item>
 366           </list>
 367           <para>The <paramref name="mode" /> string can also include the letter
 368           "b" either as a third character or as a character between the
 369           characters in any of the two-character strings described above, and
 370           is used to enable <i>binary</i> reading/writing on platforms which
 371           have different text/binary encodings (read: Microsoft Windows).  The
 372           default (non-<c>b</c><paramref name="mode" />) is text encoding.</para>
 373           <para>Any created files will have mode <c>S_IRUSR | S_IWUSR | S_IRGRP |
 374           S_IWGRP | S_IROTH | S_IWOTH</c> (0666), as modified by the process'
 375           umask value (see <see cref="M:Mono.Unix.Native.Syscall.umask" />(2)).
 376           </para>
 377           <para>ANSI C requires that a file positioning function intervene
 378           between output and input, unless an input operation encounters
 379           end-of-file.</para>
 380         </remarks>
 381         <exception cref="T:System.ArgumentNullException">
 382           <paramref name="path" /> or <paramref name="mode" /> is
 383           <see langword="null" />.
 384         </exception>
 385         <exception cref="T:System.ArgumentException">
 386           <paramref name="path" /> is a <c>0</c>-length string.
 387         </exception>
 388         <exception cref="T:System.IO.DirectoryNotFoundException">
 389           <paramref name="path" /> could not be opened.
 390         </exception>
 391         <altmember cref="M:Mono.Unix.Native.Stdlib.fopen" />
 392       </Docs>
 393       <AssemblyInfo>
 394         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 395         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 396       </AssemblyInfo>
 397     </Member>
 398     <Member MemberName=".ctor">
 399       <MemberSignature Language="C#" Value="public StdioFileStream (IntPtr fileStream, System.IO.FileAccess access, bool ownsHandle);" />
 400       <MemberType>Constructor</MemberType>
 401       <Parameters>
 402         <Parameter Name="fileStream" Type="System.IntPtr" />
 403         <Parameter Name="access" Type="System.IO.FileAccess" />
 404         <Parameter Name="ownsHandle" Type="System.Boolean" />
 405       </Parameters>
 406       <Docs>
 407         <param name="fileStream">A <see cref="T:System.IntPtr" /> containing a <c>FILE</c> pointer</param>
 408         <param name="access">A <see cref="T:System.IO.FileAccess" /> value
 409           that determins how the file may be accessed by the
 410           <see cref="T:Mono.Unix.StdioFileStream" /> object.  This parameter is
 411           used to specify the initial values of the
 412           <see cref="P:System.IO.Stream.CanRead" /> and
 413           <see cref="P:System.IO.Stream.CanWrite" /> properties.</param>
 414         <param name="ownsHandle">A <see cref="T:System.Boolean" /> specifying whether or not the created
 415           <see cref="T:Mono.Unix.StdioFileStream" /> instance "owns"
 416           <paramref name="fileStream" />.</param>
 417         <summary>Creates a <see cref="T:Mono.Unix.StdioFileStream" /> type,
 418         wrapping the existing unmanaged <c>FILE</c> pointer
 419         <paramref name="fileStream" /> with the specified file
 420         <paramref name="access" />.</summary>
 421         <remarks>If <paramref name="ownsHandle" /> is <see langword="true" />,
 422         then <paramref name="fileStream" /> will be closed via
 423         <see cref="M:Mono.Unix.Native.Stdlib.fclose" /> when
 424         <see cref="M:Mono.Unix.StdioFileStream.Close" /> is invoked (which is
 425         also called from the finalizer and from the
 426         <see cref="T:System.IDisposable" /> implementation).  Otherwise,
 427         <paramref name="fileStream" /> will only be flushed on
 428         <see cref="M:Mono.Unix.StdioFileStream.Close" /> and not actually
 429         closed.</remarks>
 430         <exception cref="T:System.ArgumentException">
 431           <paramref name="fileStream" /> is an invalid <c>FILE</c> pointer.
 432         </exception>
 433       </Docs>
 434       <AssemblyInfo>
 435         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 436         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 437       </AssemblyInfo>
 438     </Member>
 439     <Member MemberName=".ctor">
 440       <MemberSignature Language="C#" Value="public StdioFileStream (string path, System.IO.FileMode mode, System.IO.FileAccess access);" />
 441       <MemberType>Constructor</MemberType>
 442       <Parameters>
 443         <Parameter Name="path" Type="System.String" />
 444         <Parameter Name="mode" Type="System.IO.FileMode" />
 445         <Parameter Name="access" Type="System.IO.FileAccess" />
 446       </Parameters>
 447       <Docs>
 448         <param name="path">A <see cref="T:System.String" /> containing the file name to open.</param>
 449         <param name="mode">A <see cref="T:System.IO.FileMode" /> value that
 450         determines how to open or create the file.</param>
 451         <param name="access">A <see cref="T:System.IO.FileAccess" /> value
 452         that determins how the file may be accessed by the
 453         <see cref="T:Mono.Unix.StdioFileStream" /> object.  This parameter is
 454         used to specify the initial values of the
 455         <see cref="P:System.IO.Stream.CanRead" /> and
 456         <see cref="P:System.IO.Stream.CanWrite" /> properties.</param>
 457         <summary>Opens <paramref name="path" /> with the specified file mode
 458         <paramref name="mode" /> and file access
 459         <paramref name="access" />.</summary>
 460         <remarks>
 461         </remarks>
 462         <exception cref="T:System.ArgumentNullException">
 463           <paramref name="path" /> or <paramref name="mode" /> is
 464           <see langword="null" />.
 465         </exception>
 466         <exception cref="T:System.ArgumentException">
 467           <paramref name="path" /> is a <c>0</c>-length string.
 468         </exception>
 469         <exception cref="T:System.IO.DirectoryNotFoundException">
 470           <paramref name="path" /> could not be opened.
 471         </exception>
 472         <exception cref="T:System.IO.IOException">
 473           <paramref name="path" /> exists and
 474           <see cref="F:System.IO.FileMode.CreateNew" /> was specified.
 475         </exception>
 476         <exception cref="T:System.IO.FileNotFoundException">
 477           <paramref name="path" /> doesn't exist and
 478           <see cref="F:System.IO.FileMode.Open" /> was specified.
 479         </exception>
 480         <exception cref="T:System.ArgumentOutOfRangeException">
 481           <paramref name="access" /> is not one of
 482           <see cref="F:System.IO.FileAccess.Read" />,
 483           <see cref="F:System.IO.FileAccess.Write" />, or
 484           <see cref="F:System.IO.FileAccess.ReadWrite" />.
 485         </exception>
 486       </Docs>
 487       <AssemblyInfo>
 488         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 489         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 490       </AssemblyInfo>
 491     </Member>
 492     <Member MemberName="CanRead">
 493       <MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
 494       <MemberType>Property</MemberType>
 495       <ReturnValue>
 496         <ReturnType>System.Boolean</ReturnType>
 497       </ReturnValue>
 498       <Docs>
 499         <summary>To be added.</summary>
 500         <value>To be added.</value>
 501         <remarks>To be added.</remarks>
 502       </Docs>
 503       <AssemblyInfo>
 504         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 505         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 506       </AssemblyInfo>
 507     </Member>
 508     <Member MemberName="CanSeek">
 509       <MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
 510       <MemberType>Property</MemberType>
 511       <ReturnValue>
 512         <ReturnType>System.Boolean</ReturnType>
 513       </ReturnValue>
 514       <Docs>
 515         <summary>To be added.</summary>
 516         <value>To be added.</value>
 517         <remarks>To be added.</remarks>
 518       </Docs>
 519       <AssemblyInfo>
 520         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 521         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 522       </AssemblyInfo>
 523     </Member>
 524     <Member MemberName="CanWrite">
 525       <MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
 526       <MemberType>Property</MemberType>
 527       <ReturnValue>
 528         <ReturnType>System.Boolean</ReturnType>
 529       </ReturnValue>
 530       <Docs>
 531         <summary>To be added.</summary>
 532         <value>To be added.</value>
 533         <remarks>To be added.</remarks>
 534       </Docs>
 535       <AssemblyInfo>
 536         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 537         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 538       </AssemblyInfo>
 539     </Member>
 540     <Member MemberName="Close">
 541       <MemberSignature Language="C#" Value="public override void Close ();" />
 542       <MemberType>Method</MemberType>
 543       <ReturnValue>
 544         <ReturnType>System.Void</ReturnType>
 545       </ReturnValue>
 546       <Parameters />
 547       <Docs>
 548         <summary>To be added.</summary>
 549         <remarks>To be added.</remarks>
 550       </Docs>
 551       <AssemblyInfo>
 552         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 553         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 554       </AssemblyInfo>
 555     </Member>
 556     <Member MemberName="Finalize">
 557       <MemberSignature Language="C#" Value="~StdioFileStream ();" />
 558       <MemberType>Method</MemberType>
 559       <ReturnValue>
 560         <ReturnType>System.Void</ReturnType>
 561       </ReturnValue>
 562       <Parameters />
 563       <Docs>
 564         <summary>To be added.</summary>
 565         <remarks>To be added.</remarks>
 566       </Docs>
 567       <AssemblyInfo>
 568         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 569         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 570       </AssemblyInfo>
 571     </Member>
 572     <Member MemberName="Flush">
 573       <MemberSignature Language="C#" Value="public override void Flush ();" />
 574       <MemberType>Method</MemberType>
 575       <ReturnValue>
 576         <ReturnType>System.Void</ReturnType>
 577       </ReturnValue>
 578       <Parameters />
 579       <Docs>
 580         <summary>To be added.</summary>
 581         <remarks>To be added.</remarks>
 582       </Docs>
 583       <AssemblyInfo>
 584         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 585         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 586       </AssemblyInfo>
 587     </Member>
 588     <Member MemberName="Handle">
 589       <MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
 590       <MemberType>Property</MemberType>
 591       <ReturnValue>
 592         <ReturnType>System.IntPtr</ReturnType>
 593       </ReturnValue>
 594       <Docs>
 595         <summary>The underlying <c>FILE</c> pointer.</summary>
 596         <value>A <see cref="T:System.IntPtr" /> containing the underlying
 597                                         <c>FILE</c> pointer.
 598         </value>
 599         <remarks>
 600         </remarks>
 601       </Docs>
 602       <AssemblyInfo>
 603         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 604         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 605       </AssemblyInfo>
 606     </Member>
 607     <Member MemberName="InvalidFileStream">
 608       <MemberSignature Language="C#" Value="public static readonly IntPtr InvalidFileStream;" />
 609       <MemberType>Field</MemberType>
 610       <ReturnValue>
 611         <ReturnType>System.IntPtr</ReturnType>
 612       </ReturnValue>
 613       <Docs>
 614         <summary>An invalid <c>FILE</c> pointer.</summary>
 615         <remarks>This is <see cref="F:System.IntPtr.Zero" />.</remarks>
 616       </Docs>
 617       <AssemblyInfo>
 618         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 619         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 620       </AssemblyInfo>
 621     </Member>
 622     <Member MemberName="Length">
 623       <MemberSignature Language="C#" Value="public override long Length { get; }" />
 624       <MemberType>Property</MemberType>
 625       <ReturnValue>
 626         <ReturnType>System.Int64</ReturnType>
 627       </ReturnValue>
 628       <Docs>
 629         <summary>To be added.</summary>
 630         <value>To be added.</value>
 631         <remarks>To be added.</remarks>
 632       </Docs>
 633       <AssemblyInfo>
 634         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 635         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 636       </AssemblyInfo>
 637     </Member>
 638     <Member MemberName="Position">
 639       <MemberSignature Language="C#" Value="public override long Position { set; get; }" />
 640       <MemberType>Property</MemberType>
 641       <ReturnValue>
 642         <ReturnType>System.Int64</ReturnType>
 643       </ReturnValue>
 644       <Docs>
 645         <summary>To be added.</summary>
 646         <value>To be added.</value>
 647         <remarks>To be added.</remarks>
 648       </Docs>
 649       <AssemblyInfo>
 650         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 651         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 652       </AssemblyInfo>
 653     </Member>
 654     <Member MemberName="Read">
 655       <MemberSignature Language="C#" Value="public override int Read (byte[] buffer, int offset, int count);" />
 656       <MemberType>Method</MemberType>
 657       <ReturnValue>
 658         <ReturnType>System.Int32</ReturnType>
 659       </ReturnValue>
 660       <Parameters>
 661         <Parameter Name="buffer" Type="System.Byte[]" />
 662         <Parameter Name="offset" Type="System.Int32" />
 663         <Parameter Name="count" Type="System.Int32" />
 664       </Parameters>
 665       <Docs>
 666         <param name="buffer">To be added.</param>
 667         <param name="offset">To be added.</param>
 668         <param name="count">To be added.</param>
 669         <summary>To be added.</summary>
 670         <returns>To be added.</returns>
 671         <remarks>To be added.</remarks>
 672       </Docs>
 673       <AssemblyInfo>
 674         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 675         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 676       </AssemblyInfo>
 677     </Member>
 678     <Member MemberName="RestoreFilePosition">
 679       <MemberSignature Language="C#" Value="public void RestoreFilePosition (Mono.Unix.Native.FilePosition pos);" />
 680       <MemberType>Method</MemberType>
 681       <ReturnValue>
 682         <ReturnType>System.Void</ReturnType>
 683       </ReturnValue>
 684       <Parameters>
 685         <Parameter Name="pos" Type="Mono.Unix.Native.FilePosition" />
 686       </Parameters>
 687       <Docs>
 688         <param name="pos">
 689           A <see cref="T:Mono.Unix.Native.FilePosition" /> from which to
 690           restore the file position.
 691         </param>
 692         <summary>Set the current file position saved in a
 693         <see cref="T:Mono.Unix.Native.FilePosition" /> instance.</summary>
 694         <remarks>
 695           <para>The <see cref="T:Mono.Unix.Native.FilePosition" /> type holds
 696         a platform-specific representation of a file position.  This is useful
 697         when the underlying standard C library cannot hold a file position in
 698         a <c>long</c> data type.  For example, on 32-bit platforms a
 699         <c>long</c> is usually 32-bits in size; thus valid file
 700         positions as used from <see cref="P:System.IO.Stream.Position" />
 701         cannot be set past 2^31 bytes (effectively limiting you to 2GB files).
 702         </para>
 703           <para>Use this member if your underlying platform doesn't support
 704         <see cref="M:System.IO.Stream.Seek" />ing within large files, or you
 705         need to save text stream information.</para>
 706         </remarks>
 707         <altmember cref="M:Mono.Unix.Native.Stdlib.fsetpos" />
 708       </Docs>
 709       <AssemblyInfo>
 710         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 711         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 712       </AssemblyInfo>
 713     </Member>
 714     <Member MemberName="Rewind">
 715       <MemberSignature Language="C#" Value="public void Rewind ();" />
 716       <MemberType>Method</MemberType>
 717       <ReturnValue>
 718         <ReturnType>System.Void</ReturnType>
 719       </ReturnValue>
 720       <Parameters />
 721       <Docs>
 722         <summary>Set <see cref="P:Mono.Unix.StdioFileStream.Position" />
 723         to the beginning of the file.</summary>
 724         <remarks>This is equivalent to <see cref="M:System.IO.Stream.Seek" />(0,
 725         <see cref="F:System.IO.SeekOrigin.Begin" />);</remarks>
 726       </Docs>
 727       <AssemblyInfo>
 728         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 729         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 730       </AssemblyInfo>
 731     </Member>
 732     <Member MemberName="SaveFilePosition">
 733       <MemberSignature Language="C#" Value="public void SaveFilePosition (Mono.Unix.Native.FilePosition pos);" />
 734       <MemberType>Method</MemberType>
 735       <ReturnValue>
 736         <ReturnType>System.Void</ReturnType>
 737       </ReturnValue>
 738       <Parameters>
 739         <Parameter Name="pos" Type="Mono.Unix.Native.FilePosition" />
 740       </Parameters>
 741       <Docs>
 742         <param name="pos">
 743           A <see cref="T:Mono.Unix.Native.FilePosition" /> in which to save
 744           the current file position.
 745         </param>
 746         <summary>Save the current file position into a
 747         <see cref="T:Mono.Unix.Native.FilePosition" /> instance.</summary>
 748         <remarks>
 749           <para>The <see cref="T:Mono.Unix.Native.FilePosition" /> type holds
 750         a platform-specific representation of a file position.  This is useful
 751         when the underlying standard C library cannot hold a file position in
 752         a <c>long</c> data type.  For example, on 32-bit platforms a
 753         <c>long</c> is usually 32-bits in size; thus valid file
 754         positions as used from <see cref="P:System.IO.Stream.Position" />
 755         cannot be set past 2^31 bytes (effectively limiting you to 2GB files).
 756         </para>
 757           <para>Use this member if your underlying platform doesn't support
 758         <see cref="M:System.IO.Stream.Seek" />ing within large files, or you
 759         need to save text stream information.</para>
 760         </remarks>
 761         <altmember cref="M:Mono.Unix.Native.Stdlib.fgetpos" />
 762       </Docs>
 763       <AssemblyInfo>
 764         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 765         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 766       </AssemblyInfo>
 767     </Member>
 768     <Member MemberName="Seek">
 769       <MemberSignature Language="C#" Value="public override long Seek (long offset, System.IO.SeekOrigin origin);" />
 770       <MemberType>Method</MemberType>
 771       <ReturnValue>
 772         <ReturnType>System.Int64</ReturnType>
 773       </ReturnValue>
 774       <Parameters>
 775         <Parameter Name="offset" Type="System.Int64" />
 776         <Parameter Name="origin" Type="System.IO.SeekOrigin" />
 777       </Parameters>
 778       <Docs>
 779         <param name="offset">To be added.</param>
 780         <param name="origin">To be added.</param>
 781         <summary>To be added.</summary>
 782         <returns>To be added.</returns>
 783         <remarks>To be added.</remarks>
 784       </Docs>
 785       <AssemblyInfo>
 786         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 787         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 788       </AssemblyInfo>
 789     </Member>
 790     <Member MemberName="SetLength">
 791       <MemberSignature Language="C#" Value="public override void SetLength (long value);" />
 792       <MemberType>Method</MemberType>
 793       <ReturnValue>
 794         <ReturnType>System.Void</ReturnType>
 795       </ReturnValue>
 796       <Parameters>
 797         <Parameter Name="value" Type="System.Int64" />
 798       </Parameters>
 799       <Docs>
 800         <param name="value">To be added.</param>
 801         <summary>To be added.</summary>
 802         <remarks>To be added.</remarks>
 803       </Docs>
 804       <AssemblyInfo>
 805         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 806         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 807       </AssemblyInfo>
 808     </Member>
 809     <Member MemberName="StandardError">
 810       <MemberSignature Language="C#" Value="public static readonly IntPtr StandardError;" />
 811       <MemberType>Field</MemberType>
 812       <ReturnValue>
 813         <ReturnType>System.IntPtr</ReturnType>
 814       </ReturnValue>
 815       <Docs>
 816         <summary>The standard error file stream.</summary>
 817         <remarks>This is the
 818         <see cref="F:Mono.Unix.Native.Stdlib.stderr" /> global variable.</remarks>
 819       </Docs>
 820       <AssemblyInfo>
 821         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 822         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 823       </AssemblyInfo>
 824     </Member>
 825     <Member MemberName="StandardInput">
 826       <MemberSignature Language="C#" Value="public static readonly IntPtr StandardInput;" />
 827       <MemberType>Field</MemberType>
 828       <ReturnValue>
 829         <ReturnType>System.IntPtr</ReturnType>
 830       </ReturnValue>
 831       <Docs>
 832         <summary>The standard input file stream.</summary>
 833         <remarks>This is the
 834         <see cref="F:Mono.Unix.Native.Stdlib.stdin" /> global variable.</remarks>
 835       </Docs>
 836       <AssemblyInfo>
 837         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 838         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 839       </AssemblyInfo>
 840     </Member>
 841     <Member MemberName="StandardOutput">
 842       <MemberSignature Language="C#" Value="public static readonly IntPtr StandardOutput;" />
 843       <MemberType>Field</MemberType>
 844       <ReturnValue>
 845         <ReturnType>System.IntPtr</ReturnType>
 846       </ReturnValue>
 847       <Docs>
 848         <summary>The standard output file stream.</summary>
 849         <remarks>This is the
 850         <see cref="F:Mono.Unix.Native.Stdlib.stdout" /> global variable.</remarks>
 851       </Docs>
 852       <AssemblyInfo>
 853         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 854         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 855       </AssemblyInfo>
 856     </Member>
 857     <Member MemberName="Write">
 858       <MemberSignature Language="C#" Value="public override void Write (byte[] buffer, int offset, int count);" />
 859       <MemberType>Method</MemberType>
 860       <ReturnValue>
 861         <ReturnType>System.Void</ReturnType>
 862       </ReturnValue>
 863       <Parameters>
 864         <Parameter Name="buffer" Type="System.Byte[]" />
 865         <Parameter Name="offset" Type="System.Int32" />
 866         <Parameter Name="count" Type="System.Int32" />
 867       </Parameters>
 868       <Docs>
 869         <param name="buffer">To be added.</param>
 870         <param name="offset">To be added.</param>
 871         <param name="count">To be added.</param>
 872         <summary>To be added.</summary>
 873         <remarks>To be added.</remarks>
 874       </Docs>
 875       <AssemblyInfo>
 876         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 877         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 878       </AssemblyInfo>
 879     </Member>
 880   </Members>
 881 </Type>