mcs/class/Mono.Posix/Documentation/en/Mono.Unix.Native/FilePosition.xml

   1 <Type Name="FilePosition" FullName="Mono.Unix.Native.FilePosition">
   2   <TypeSignature Language="C#" Value="public sealed class FilePosition : MarshalByRefObject, IDisposable, IEquatable&lt;Mono.Unix.Native.FilePosition&gt;" />
   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>
   9   All public static members of this type are safe for multithreaded operations.
  10   No instance members are guaranteed to be thread safe.
  11   </ThreadingSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.IDisposable</InterfaceName>
  18     </Interface>
  19     <Interface>
  20       <InterfaceName>System.IEquatable&lt;Mono.Unix.Native.FilePosition&gt;</InterfaceName>
  21     </Interface>
  22   </Interfaces>
  23   <Docs>
  24     <summary>A wrapper for the platform-specific <paramref name="fpos_t" />.</summary>
  25     <remarks>
  26       <para>
  27         <c>FilePosition</c> is an alternate mechanism for specifying a
  28     location within a file, which can take into account text vs. binary
  29     <c>FILE</c> stream differences.  It exists to support platforms for which
  30     file positions can exceed the size of <see langword="long" />.</para>
  31       <para>
  32         <c>FilePosition</c> wraps unmanaged memory.  It contains a finalizer
  33     to free this memory, but using <see cref="M:Mono.Unix.Native.FilePosition.Dispose" /> is highly recommended to avoid
  34     additional GC pressure.</para>
  35     </remarks>
  36     <altmember cref="M:Mono.Unix.StdioFileStream.RestoreFilePosition" />
  37     <altmember cref="M:Mono.Unix.StdioFileStream.SaveFilePosition" />
  38     <altmember cref="M:Mono.Unix.Native.Stdlib.fgetpos" />
  39     <altmember cref="M:Mono.Unix.Native.Stdlib.fsetpos" />
  40   </Docs>
  41   <Members>
  42     <Member MemberName=".ctor">
  43       <MemberSignature Language="C#" Value="public FilePosition ();" />
  44       <MemberType>Constructor</MemberType>
  45       <Parameters />
  46       <Docs>
  47         <summary>Constructs and initializes a file position instance.</summary>
  48         <remarks>
  49         </remarks>
  50       </Docs>
  51       <AssemblyInfo>
  52         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  53         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55     </Member>
  56     <Member MemberName="Dispose">
  57       <MemberSignature Language="C#" Value="public void Dispose ();" />
  58       <MemberType>Method</MemberType>
  59       <ReturnValue>
  60         <ReturnType>System.Void</ReturnType>
  61       </ReturnValue>
  62       <Parameters />
  63       <Docs>
  64         <summary>Frees the wrapped <c>fpos_t</c> instance.</summary>
  65         <remarks>This method should be called whenever a <c>FilePosition</c>
  66         is no longer needed.</remarks>
  67       </Docs>
  68       <AssemblyInfo>
  69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  71       </AssemblyInfo>
  72     </Member>
  73     <Member MemberName="Equals">
  74       <MemberSignature Language="C#" Value="public bool Equals (Mono.Unix.Native.FilePosition value);" />
  75       <MemberType>Method</MemberType>
  76       <ReturnValue>
  77         <ReturnType>System.Boolean</ReturnType>
  78       </ReturnValue>
  79       <Parameters>
  80         <Parameter Name="value" Type="Mono.Unix.Native.FilePosition" />
  81       </Parameters>
  82       <Docs>
  83         <param name="value">To be added.</param>
  84         <summary>To be added.</summary>
  85         <returns>To be added.</returns>
  86         <remarks>To be added.</remarks>
  87       </Docs>
  88       <AssemblyInfo>
  89         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  90         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  91       </AssemblyInfo>
  92     </Member>
  93     <Member MemberName="Equals">
  94       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
  95       <MemberType>Method</MemberType>
  96       <ReturnValue>
  97         <ReturnType>System.Boolean</ReturnType>
  98       </ReturnValue>
  99       <Parameters>
 100         <Parameter Name="obj" Type="System.Object" />
 101       </Parameters>
 102       <Docs>
 103         <param name="obj">To be added.</param>
 104         <summary>To be added.</summary>
 105         <returns>To be added.</returns>
 106         <remarks>To be added.</remarks>
 107       </Docs>
 108       <AssemblyInfo>
 109         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 110         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 111       </AssemblyInfo>
 112     </Member>
 113     <Member MemberName="Finalize">
 114       <MemberSignature Language="C#" Value="~FilePosition ();" />
 115       <MemberType>Method</MemberType>
 116       <ReturnValue>
 117         <ReturnType>System.Void</ReturnType>
 118       </ReturnValue>
 119       <Parameters />
 120       <Docs>
 121         <summary>To be added.</summary>
 122         <remarks>To be added.</remarks>
 123       </Docs>
 124       <AssemblyInfo>
 125         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 126         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 127       </AssemblyInfo>
 128     </Member>
 129     <Member MemberName="GetHashCode">
 130       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
 131       <MemberType>Method</MemberType>
 132       <ReturnValue>
 133         <ReturnType>System.Int32</ReturnType>
 134       </ReturnValue>
 135       <Parameters />
 136       <Docs>
 137         <summary>To be added.</summary>
 138         <returns>To be added.</returns>
 139         <remarks>To be added.</remarks>
 140       </Docs>
 141       <AssemblyInfo>
 142         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 143         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 144       </AssemblyInfo>
 145     </Member>
 146     <Member MemberName="op_Equality">
 147       <MemberSignature Language="C#" Value="public static bool op_Equality (Mono.Unix.Native.FilePosition lhs, Mono.Unix.Native.FilePosition rhs);" />
 148       <MemberType>Method</MemberType>
 149       <ReturnValue>
 150         <ReturnType>System.Boolean</ReturnType>
 151       </ReturnValue>
 152       <Parameters>
 153         <Parameter Name="lhs" Type="Mono.Unix.Native.FilePosition" />
 154         <Parameter Name="rhs" Type="Mono.Unix.Native.FilePosition" />
 155       </Parameters>
 156       <Docs>
 157         <param name="lhs">To be added.</param>
 158         <param name="rhs">To be added.</param>
 159         <summary>To be added.</summary>
 160         <returns>To be added.</returns>
 161         <remarks>To be added.</remarks>
 162       </Docs>
 163       <AssemblyInfo>
 164         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 165         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 166       </AssemblyInfo>
 167     </Member>
 168     <Member MemberName="op_Inequality">
 169       <MemberSignature Language="C#" Value="public static bool op_Inequality (Mono.Unix.Native.FilePosition lhs, Mono.Unix.Native.FilePosition rhs);" />
 170       <MemberType>Method</MemberType>
 171       <ReturnValue>
 172         <ReturnType>System.Boolean</ReturnType>
 173       </ReturnValue>
 174       <Parameters>
 175         <Parameter Name="lhs" Type="Mono.Unix.Native.FilePosition" />
 176         <Parameter Name="rhs" Type="Mono.Unix.Native.FilePosition" />
 177       </Parameters>
 178       <Docs>
 179         <param name="lhs">To be added.</param>
 180         <param name="rhs">To be added.</param>
 181         <summary>To be added.</summary>
 182         <returns>To be added.</returns>
 183         <remarks>To be added.</remarks>
 184       </Docs>
 185       <AssemblyInfo>
 186         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 187         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 188       </AssemblyInfo>
 189     </Member>
 190     <Member MemberName="ToString">
 191       <MemberSignature Language="C#" Value="public override string ToString ();" />
 192       <MemberType>Method</MemberType>
 193       <ReturnValue>
 194         <ReturnType>System.String</ReturnType>
 195       </ReturnValue>
 196       <Parameters />
 197       <Docs>
 198         <summary>To be added.</summary>
 199         <returns>To be added.</returns>
 200         <remarks>To be added.</remarks>
 201       </Docs>
 202       <AssemblyInfo>
 203         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 204         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 205       </AssemblyInfo>
 206     </Member>
 207   </Members>
 208 </Type>