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

   1 <Type Name="Stat" FullName="Mono.Unix.Native.Stat">
   2   <TypeSignature Language="C#" Value="public struct Stat : IEquatable&lt;Mono.Unix.Native.Stat&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.ValueType</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.IEquatable&lt;Mono.Unix.Native.Stat&gt;</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <summary>Every file has a unique INODE data structure. Mono's managed representation is the Stat struct. the <see cref="M:Mono.Unix.Native.Syscall.stat" /> and <see cref="M:Mono.Unix.Native.Syscall.lstat" /> methods return the Stat struct as an output parameter.</summary>
  22     <remarks>See <c>stat</c>(2) for more information. Not all filesystems implement all of the time fields and certain mount types can affect the ATime value as well. See <c>mount</c>(8) for more information.</remarks>
  23     <altmember cref="M:Mono.Unix.Native.Syscall.fstat" />
  24     <altmember cref="M:Mono.Unix.Native.Syscall.lstat" />
  25     <altmember cref="M:Mono.Unix.Native.Syscall.stat" />
  26   </Docs>
  27   <Members>
  28     <Member MemberName="Equals">
  29       <MemberSignature Language="C#" Value="public bool Equals (Mono.Unix.Native.Stat value);" />
  30       <MemberType>Method</MemberType>
  31       <ReturnValue>
  32         <ReturnType>System.Boolean</ReturnType>
  33       </ReturnValue>
  34       <Parameters>
  35         <Parameter Name="value" Type="Mono.Unix.Native.Stat" />
  36       </Parameters>
  37       <Docs>
  38         <param name="value">To be added.</param>
  39         <summary>To be added.</summary>
  40         <returns>To be added.</returns>
  41         <remarks>To be added.</remarks>
  42       </Docs>
  43       <AssemblyInfo>
  44         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  45         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47     </Member>
  48     <Member MemberName="Equals">
  49       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
  50       <MemberType>Method</MemberType>
  51       <ReturnValue>
  52         <ReturnType>System.Boolean</ReturnType>
  53       </ReturnValue>
  54       <Parameters>
  55         <Parameter Name="obj" Type="System.Object" />
  56       </Parameters>
  57       <Docs>
  58         <param name="obj">To be added.</param>
  59         <summary>To be added.</summary>
  60         <returns>To be added.</returns>
  61         <remarks>To be added.</remarks>
  62       </Docs>
  63       <AssemblyInfo>
  64         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  65         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  66       </AssemblyInfo>
  67     </Member>
  68     <Member MemberName="GetHashCode">
  69       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
  70       <MemberType>Method</MemberType>
  71       <ReturnValue>
  72         <ReturnType>System.Int32</ReturnType>
  73       </ReturnValue>
  74       <Parameters />
  75       <Docs>
  76         <summary>To be added.</summary>
  77         <returns>To be added.</returns>
  78         <remarks>To be added.</remarks>
  79       </Docs>
  80       <AssemblyInfo>
  81         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  82         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84     </Member>
  85     <Member MemberName="op_Equality">
  86       <MemberSignature Language="C#" Value="public static bool op_Equality (Mono.Unix.Native.Stat lhs, Mono.Unix.Native.Stat rhs);" />
  87       <MemberType>Method</MemberType>
  88       <ReturnValue>
  89         <ReturnType>System.Boolean</ReturnType>
  90       </ReturnValue>
  91       <Parameters>
  92         <Parameter Name="lhs" Type="Mono.Unix.Native.Stat" />
  93         <Parameter Name="rhs" Type="Mono.Unix.Native.Stat" />
  94       </Parameters>
  95       <Docs>
  96         <param name="lhs">To be added.</param>
  97         <param name="rhs">To be added.</param>
  98         <summary>To be added.</summary>
  99         <returns>To be added.</returns>
 100         <remarks>To be added.</remarks>
 101       </Docs>
 102       <AssemblyInfo>
 103         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 104         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 105       </AssemblyInfo>
 106     </Member>
 107     <Member MemberName="op_Inequality">
 108       <MemberSignature Language="C#" Value="public static bool op_Inequality (Mono.Unix.Native.Stat lhs, Mono.Unix.Native.Stat rhs);" />
 109       <MemberType>Method</MemberType>
 110       <ReturnValue>
 111         <ReturnType>System.Boolean</ReturnType>
 112       </ReturnValue>
 113       <Parameters>
 114         <Parameter Name="lhs" Type="Mono.Unix.Native.Stat" />
 115         <Parameter Name="rhs" Type="Mono.Unix.Native.Stat" />
 116       </Parameters>
 117       <Docs>
 118         <param name="lhs">To be added.</param>
 119         <param name="rhs">To be added.</param>
 120         <summary>To be added.</summary>
 121         <returns>To be added.</returns>
 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="st_atime">
 130       <MemberSignature Language="C#" Value="public long st_atime;" />
 131       <MemberType>Field</MemberType>
 132       <ReturnValue>
 133         <ReturnType>System.Int64</ReturnType>
 134       </ReturnValue>
 135       <Docs>
 136         <summary>Last access time.</summary>
 137         <remarks />
 138       </Docs>
 139       <AssemblyInfo>
 140         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 141         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 142       </AssemblyInfo>
 143     </Member>
 144     <Member MemberName="st_blksize">
 145       <MemberSignature Language="C#" Value="public long st_blksize;" />
 146       <MemberType>Field</MemberType>
 147       <ReturnValue>
 148         <ReturnType>System.Int64</ReturnType>
 149       </ReturnValue>
 150       <Docs>
 151         <summary>Contains the preferred block size for efficient file system I/O.</summary>
 152         <remarks />
 153       </Docs>
 154       <AssemblyInfo>
 155         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 156         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 157       </AssemblyInfo>
 158     </Member>
 159     <Member MemberName="st_blocks">
 160       <MemberSignature Language="C#" Value="public long st_blocks;" />
 161       <MemberType>Field</MemberType>
 162       <ReturnValue>
 163         <ReturnType>System.Int64</ReturnType>
 164       </ReturnValue>
 165       <Docs>
 166         <summary>Blocks gives the size of the file in 512-byte blocks.</summary>
 167         <remarks>This may be smaller than Size/512 e.g. when the file has holes.</remarks>
 168       </Docs>
 169       <AssemblyInfo>
 170         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 171         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 172       </AssemblyInfo>
 173     </Member>
 174     <Member MemberName="st_ctime">
 175       <MemberSignature Language="C#" Value="public long st_ctime;" />
 176       <MemberType>Field</MemberType>
 177       <ReturnValue>
 178         <ReturnType>System.Int64</ReturnType>
 179       </ReturnValue>
 180       <Docs>
 181         <summary>Creation time.</summary>
 182         <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="st_dev">
 190       <MemberSignature Language="C#" Value="public ulong st_dev;" />
 191       <MemberType>Field</MemberType>
 192       <ReturnValue>
 193         <ReturnType>System.UInt64</ReturnType>
 194       </ReturnValue>
 195       <Docs>
 196         <summary>A device number on which the file resides.</summary>
 197         <remarks />
 198       </Docs>
 199       <Attributes>
 200         <Attribute>
 201           <AttributeName>System.CLSCompliant(false)</AttributeName>
 202         </Attribute>
 203       </Attributes>
 204       <AssemblyInfo>
 205         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 206         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 207       </AssemblyInfo>
 208     </Member>
 209     <Member MemberName="st_gid">
 210       <MemberSignature Language="C#" Value="public uint st_gid;" />
 211       <MemberType>Field</MemberType>
 212       <ReturnValue>
 213         <ReturnType>System.UInt32</ReturnType>
 214       </ReturnValue>
 215       <Docs>
 216         <summary>Group ID.</summary>
 217         <remarks />
 218       </Docs>
 219       <Attributes>
 220         <Attribute>
 221           <AttributeName>System.CLSCompliant(false)</AttributeName>
 222         </Attribute>
 223       </Attributes>
 224       <AssemblyInfo>
 225         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 226         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 227       </AssemblyInfo>
 228     </Member>
 229     <Member MemberName="st_ino">
 230       <MemberSignature Language="C#" Value="public ulong st_ino;" />
 231       <MemberType>Field</MemberType>
 232       <ReturnValue>
 233         <ReturnType>System.UInt64</ReturnType>
 234       </ReturnValue>
 235       <Docs>
 236         <summary>The inode number of file on disk.</summary>
 237         <remarks />
 238       </Docs>
 239       <Attributes>
 240         <Attribute>
 241           <AttributeName>System.CLSCompliant(false)</AttributeName>
 242         </Attribute>
 243       </Attributes>
 244       <AssemblyInfo>
 245         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 246         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 247       </AssemblyInfo>
 248     </Member>
 249     <Member MemberName="st_mode">
 250       <MemberSignature Language="C#" Value="public Mono.Unix.Native.FilePermissions st_mode;" />
 251       <MemberType>Field</MemberType>
 252       <ReturnValue>
 253         <ReturnType>Mono.Unix.Native.FilePermissions</ReturnType>
 254       </ReturnValue>
 255       <Docs>
 256         <summary>The file permissions/protection.</summary>
 257         <remarks />
 258       </Docs>
 259       <Attributes>
 260         <Attribute>
 261           <AttributeName>System.CLSCompliant(false)</AttributeName>
 262         </Attribute>
 263       </Attributes>
 264       <AssemblyInfo>
 265         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 266         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 267       </AssemblyInfo>
 268     </Member>
 269     <Member MemberName="st_mtime">
 270       <MemberSignature Language="C#" Value="public long st_mtime;" />
 271       <MemberType>Field</MemberType>
 272       <ReturnValue>
 273         <ReturnType>System.Int64</ReturnType>
 274       </ReturnValue>
 275       <Docs>
 276         <summary>Time of last modification.</summary>
 277         <remarks />
 278       </Docs>
 279       <AssemblyInfo>
 280         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 281         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 282       </AssemblyInfo>
 283     </Member>
 284     <Member MemberName="st_nlink">
 285       <MemberSignature Language="C#" Value="public ulong st_nlink;" />
 286       <MemberType>Field</MemberType>
 287       <ReturnValue>
 288         <ReturnType>System.UInt64</ReturnType>
 289       </ReturnValue>
 290       <Docs>
 291         <summary>The number of pathnames or links that reference this inode.</summary>
 292         <remarks />
 293       </Docs>
 294       <Attributes>
 295         <Attribute>
 296           <AttributeName>System.CLSCompliant(false)</AttributeName>
 297         </Attribute>
 298       </Attributes>
 299       <AssemblyInfo>
 300         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 301         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 302       </AssemblyInfo>
 303     </Member>
 304     <Member MemberName="st_rdev">
 305       <MemberSignature Language="C#" Value="public ulong st_rdev;" />
 306       <MemberType>Field</MemberType>
 307       <ReturnValue>
 308         <ReturnType>System.UInt64</ReturnType>
 309       </ReturnValue>
 310       <Docs>
 311         <summary>Device type (if inode device).</summary>
 312         <remarks />
 313       </Docs>
 314       <Attributes>
 315         <Attribute>
 316           <AttributeName>System.CLSCompliant(false)</AttributeName>
 317         </Attribute>
 318       </Attributes>
 319       <AssemblyInfo>
 320         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 321         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 322       </AssemblyInfo>
 323     </Member>
 324     <Member MemberName="st_size">
 325       <MemberSignature Language="C#" Value="public long st_size;" />
 326       <MemberType>Field</MemberType>
 327       <ReturnValue>
 328         <ReturnType>System.Int64</ReturnType>
 329       </ReturnValue>
 330       <Docs>
 331         <summary>Size gives the size of the file in bytes.</summary>
 332         <remarks>If the file is a symlink and <see cref="M:Mono.Unix.Native.Syscall.lstat" /> was used, then this is the length of the pathname it contains without trailing null.</remarks>
 333       </Docs>
 334       <AssemblyInfo>
 335         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 336         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 337       </AssemblyInfo>
 338     </Member>
 339     <Member MemberName="st_uid">
 340       <MemberSignature Language="C#" Value="public uint st_uid;" />
 341       <MemberType>Field</MemberType>
 342       <ReturnValue>
 343         <ReturnType>System.UInt32</ReturnType>
 344       </ReturnValue>
 345       <Docs>
 346         <summary>The owner user ID.</summary>
 347         <remarks>To be added.</remarks>
 348       </Docs>
 349       <Attributes>
 350         <Attribute>
 351           <AttributeName>System.CLSCompliant(false)</AttributeName>
 352         </Attribute>
 353       </Attributes>
 354       <AssemblyInfo>
 355         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 356         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 357       </AssemblyInfo>
 358     </Member>
 359   </Members>
 360 </Type>