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

   1 <Type Name="Stat" FullName="Mono.Posix.Stat">
   2   <TypeSignature Language="C#" Maintainer="auto" Value="public struct Stat" />
   3   <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Stat extends System.ValueType" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Posix</AssemblyName>
   6     <AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 79 15 99 77 D2 D0 3A 8E 6B EA 7A 2E 74 E8 D1 AF CC 93 E8 85 19 74 95 2B B4 80 A1 2C 91 34 47 4D 04 06 24 47 C3 7E 0E 68 C0 80 53 6F CF 3C 3F BE 2F F9 C9 79 CE 99 84 75 E5 06 E8 CE 82 DD 5B 0F 35 0D C1 0E 93 BF 2E EE CF 87 4B 24 77 0C 50 81 DB EA 74 47 FD DA FA 27 7B 22 DE 47 D6 FF EA 44 96 74 A4 F9 FC CF 84 D1 50 69 08 93 80 28 4D BD D3 5F 46 CD FF 12 A1 BD 78 E4 EF 00 65 D0 16 DF]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   8     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   9     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.ValueType</BaseTypeName>
  14   </Base>
  15   <Interfaces />
  16   <Attributes>
  17     <Attribute>
  18       <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat")</AttributeName>
  19     </Attribute>
  20   </Attributes>
  21   <Docs>
  22     <summary>Every file has a unique INODE data structure. Mono's managed representation is the Stat struct. the Syscall.stat and Syscall.lstat methods return the Stat struct as an output parameter.</summary>
  23     <remarks>
  24       <para>See 'man stat(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 'man mount(8)' for more information.</para>
  25       <para>This type is obsolete.  Please use
  26     <see cref="T:Mono.Unix.Native.Stat" /> instead.</para>
  27     </remarks>
  28     <altmember cref="T:Mono.Unix.Native.Stat" />
  29   </Docs>
  30   <Members>
  31     <Member MemberName="ATime">
  32       <MemberSignature Language="C#" Value="public readonly DateTime ATime;" />
  33       <MemberSignature Language="ILAsm" Value=".field public initonly valuetype System.DateTime ATime" />
  34       <MemberType>Field</MemberType>
  35       <AssemblyInfo>
  36         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  38         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  39       </AssemblyInfo>
  40       <Attributes>
  41         <Attribute>
  42           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_atime")</AttributeName>
  43         </Attribute>
  44       </Attributes>
  45       <ReturnValue>
  46         <ReturnType>System.DateTime</ReturnType>
  47       </ReturnValue>
  48       <Parameters>
  49       </Parameters>
  50       <Docs>
  51         <summary>Last access time.</summary>
  52         <remarks />
  53       </Docs>
  54     </Member>
  55     <Member MemberName="Blocks">
  56       <MemberSignature Language="C#" Value="public readonly long Blocks;" />
  57       <MemberSignature Language="ILAsm" Value=".field public initonly int64 Blocks" />
  58       <MemberType>Field</MemberType>
  59       <AssemblyInfo>
  60         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  61         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  62         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  63       </AssemblyInfo>
  64       <Attributes>
  65         <Attribute>
  66           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_blocks")</AttributeName>
  67         </Attribute>
  68       </Attributes>
  69       <ReturnValue>
  70         <ReturnType>System.Int64</ReturnType>
  71       </ReturnValue>
  72       <Parameters>
  73       </Parameters>
  74       <Docs>
  75         <summary>Blocks gives the size of the file in 512-byte blocks. </summary>
  76         <remarks>This may be smaller than Size/512 e.g. when the file has holes.</remarks>
  77       </Docs>
  78     </Member>
  79     <Member MemberName="BlockSize">
  80       <MemberSignature Language="C#" Value="public readonly long BlockSize;" />
  81       <MemberSignature Language="ILAsm" Value=".field public initonly int64 BlockSize" />
  82       <MemberType>Field</MemberType>
  83       <AssemblyInfo>
  84         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  85         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  86         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  87       </AssemblyInfo>
  88       <Attributes>
  89         <Attribute>
  90           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_blksize")</AttributeName>
  91         </Attribute>
  92       </Attributes>
  93       <ReturnValue>
  94         <ReturnType>System.Int64</ReturnType>
  95       </ReturnValue>
  96       <Parameters>
  97       </Parameters>
  98       <Docs>
  99         <summary>Contains the preferred block size for efficient file system I/O.</summary>
 100         <remarks />
 101       </Docs>
 102     </Member>
 103     <Member MemberName="CTime">
 104       <MemberSignature Language="C#" Value="public readonly DateTime CTime;" />
 105       <MemberSignature Language="ILAsm" Value=".field public initonly valuetype System.DateTime CTime" />
 106       <MemberType>Field</MemberType>
 107       <AssemblyInfo>
 108         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 109         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 110         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 111       </AssemblyInfo>
 112       <Attributes>
 113         <Attribute>
 114           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_ctime")</AttributeName>
 115         </Attribute>
 116       </Attributes>
 117       <ReturnValue>
 118         <ReturnType>System.DateTime</ReturnType>
 119       </ReturnValue>
 120       <Parameters>
 121       </Parameters>
 122       <Docs>
 123         <summary>Creation time.</summary>
 124         <remarks />
 125       </Docs>
 126     </Member>
 127     <Member MemberName="Device">
 128       <MemberSignature Language="C#" Value="public readonly int Device;" />
 129       <MemberSignature Language="ILAsm" Value=".field public initonly int32 Device" />
 130       <MemberType>Field</MemberType>
 131       <AssemblyInfo>
 132         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 133         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 134         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 135       </AssemblyInfo>
 136       <Attributes>
 137         <Attribute>
 138           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_dev")</AttributeName>
 139         </Attribute>
 140       </Attributes>
 141       <ReturnValue>
 142         <ReturnType>System.Int32</ReturnType>
 143       </ReturnValue>
 144       <Parameters>
 145       </Parameters>
 146       <Docs>
 147         <summary>A device number on which the file resides.</summary>
 148         <remarks>To be added</remarks>
 149       </Docs>
 150     </Member>
 151     <Member MemberName="DeviceType">
 152       <MemberSignature Language="C#" Value="public readonly long DeviceType;" />
 153       <MemberSignature Language="ILAsm" Value=".field public initonly int64 DeviceType" />
 154       <MemberType>Field</MemberType>
 155       <AssemblyInfo>
 156         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 157         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 158         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 159       </AssemblyInfo>
 160       <Attributes>
 161         <Attribute>
 162           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_rdev")</AttributeName>
 163         </Attribute>
 164       </Attributes>
 165       <ReturnValue>
 166         <ReturnType>System.Int64</ReturnType>
 167       </ReturnValue>
 168       <Parameters>
 169       </Parameters>
 170       <Docs>
 171         <summary>For a character or block device, the device major and minor numbers.</summary>
 172         <remarks />
 173       </Docs>
 174     </Member>
 175     <Member MemberName="Gid">
 176       <MemberSignature Language="C#" Value="public readonly int Gid;" />
 177       <MemberSignature Language="ILAsm" Value=".field public initonly int32 Gid" />
 178       <MemberType>Field</MemberType>
 179       <AssemblyInfo>
 180         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 181         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 182         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 183       </AssemblyInfo>
 184       <Attributes>
 185         <Attribute>
 186           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_gid")</AttributeName>
 187         </Attribute>
 188       </Attributes>
 189       <ReturnValue>
 190         <ReturnType>System.Int32</ReturnType>
 191       </ReturnValue>
 192       <Parameters>
 193       </Parameters>
 194       <Docs>
 195         <summary>Group ID</summary>
 196         <remarks />
 197       </Docs>
 198     </Member>
 199     <Member MemberName="INode">
 200       <MemberSignature Language="C#" Value="public readonly int INode;" />
 201       <MemberSignature Language="ILAsm" Value=".field public initonly int32 INode" />
 202       <MemberType>Field</MemberType>
 203       <AssemblyInfo>
 204         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 205         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 206         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 207       </AssemblyInfo>
 208       <Attributes>
 209         <Attribute>
 210           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_ino")</AttributeName>
 211         </Attribute>
 212       </Attributes>
 213       <ReturnValue>
 214         <ReturnType>System.Int32</ReturnType>
 215       </ReturnValue>
 216       <Parameters>
 217       </Parameters>
 218       <Docs>
 219         <summary>The inode number of file on disk.</summary>
 220         <remarks />
 221       </Docs>
 222     </Member>
 223     <Member MemberName="Mode">
 224       <MemberSignature Language="C#" Value="public readonly Mono.Posix.StatMode Mode;" />
 225       <MemberSignature Language="ILAsm" Value=".field public initonly valuetype Mono.Posix.StatMode Mode" />
 226       <MemberType>Field</MemberType>
 227       <AssemblyInfo>
 228         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 229         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 230         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 231       </AssemblyInfo>
 232       <Attributes>
 233         <Attribute>
 234           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_mode")</AttributeName>
 235         </Attribute>
 236       </Attributes>
 237       <ReturnValue>
 238         <ReturnType>Mono.Posix.StatMode</ReturnType>
 239       </ReturnValue>
 240       <Parameters>
 241       </Parameters>
 242       <Docs>
 243         <summary>The file mode as defined by the StatMode enumeration.</summary>
 244         <remarks>To be added</remarks>
 245       </Docs>
 246     </Member>
 247     <Member MemberName="MTime">
 248       <MemberSignature Language="C#" Value="public readonly DateTime MTime;" />
 249       <MemberSignature Language="ILAsm" Value=".field public initonly valuetype System.DateTime MTime" />
 250       <MemberType>Field</MemberType>
 251       <AssemblyInfo>
 252         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 253         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 254         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 255       </AssemblyInfo>
 256       <Attributes>
 257         <Attribute>
 258           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_mtime")</AttributeName>
 259         </Attribute>
 260       </Attributes>
 261       <ReturnValue>
 262         <ReturnType>System.DateTime</ReturnType>
 263       </ReturnValue>
 264       <Parameters>
 265       </Parameters>
 266       <Docs>
 267         <summary>File last modified.</summary>
 268         <remarks />
 269       </Docs>
 270     </Member>
 271     <Member MemberName="NLinks">
 272       <MemberSignature Language="C#" Value="public readonly int NLinks;" />
 273       <MemberSignature Language="ILAsm" Value=".field public initonly int32 NLinks" />
 274       <MemberType>Field</MemberType>
 275       <AssemblyInfo>
 276         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 277         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 278         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 279       </AssemblyInfo>
 280       <Attributes>
 281         <Attribute>
 282           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_nlink")</AttributeName>
 283         </Attribute>
 284       </Attributes>
 285       <ReturnValue>
 286         <ReturnType>System.Int32</ReturnType>
 287       </ReturnValue>
 288       <Parameters>
 289       </Parameters>
 290       <Docs>
 291         <summary>The number of pathnames or links that reference this inode.</summary>
 292         <remarks />
 293       </Docs>
 294     </Member>
 295     <Member MemberName="Size">
 296       <MemberSignature Language="C#" Value="public readonly long Size;" />
 297       <MemberSignature Language="ILAsm" Value=".field public initonly int64 Size" />
 298       <MemberType>Field</MemberType>
 299       <AssemblyInfo>
 300         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 301         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 302         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 303       </AssemblyInfo>
 304       <Attributes>
 305         <Attribute>
 306           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_size")</AttributeName>
 307         </Attribute>
 308       </Attributes>
 309       <ReturnValue>
 310         <ReturnType>System.Int64</ReturnType>
 311       </ReturnValue>
 312       <Parameters>
 313       </Parameters>
 314       <Docs>
 315         <summary>Size gives the size of the file in bytes.</summary>
 316         <remarks>If the file is a symlink then this is the length of the pathname it contains without trailing null.</remarks>
 317       </Docs>
 318     </Member>
 319     <Member MemberName="Uid">
 320       <MemberSignature Language="C#" Value="public readonly int Uid;" />
 321       <MemberSignature Language="ILAsm" Value=".field public initonly int32 Uid" />
 322       <MemberType>Field</MemberType>
 323       <AssemblyInfo>
 324         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 325         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 326         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 327       </AssemblyInfo>
 328       <Attributes>
 329         <Attribute>
 330           <AttributeName>System.Obsolete("Use Mono.Unix.Native.Stat.st_uid")</AttributeName>
 331         </Attribute>
 332       </Attributes>
 333       <ReturnValue>
 334         <ReturnType>System.Int32</ReturnType>
 335       </ReturnValue>
 336       <Parameters>
 337       </Parameters>
 338       <Docs>
 339         <summary>The owner user ID</summary>
 340         <remarks />
 341       </Docs>
 342     </Member>
 343     <Member MemberName="UnixEpoch">
 344       <MemberSignature Language="C#" Value="public static readonly DateTime UnixEpoch;" />
 345       <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype System.DateTime UnixEpoch" />
 346       <MemberType>Field</MemberType>
 347       <AssemblyInfo>
 348         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 349         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 350         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 351       </AssemblyInfo>
 352       <Attributes>
 353         <Attribute>
 354           <AttributeName>System.Obsolete("Use Mono.Unix.Native.NativeConvert.LocalUnixEpoch")</AttributeName>
 355         </Attribute>
 356       </Attributes>
 357       <ReturnValue>
 358         <ReturnType>System.DateTime</ReturnType>
 359       </ReturnValue>
 360       <Parameters>
 361       </Parameters>
 362       <MemberValue>1/1/1970 12:00:00 AM</MemberValue>
 363       <Docs>
 364         <summary>DateTime value corresponding to Unix Epoch (1/1/1970)</summary>
 365         <remarks>Read-only.</remarks>
 366       </Docs>
 367     </Member>
 368     <Member MemberName="UnixToDateTime">
 369       <MemberSignature Language="C#" Value="public static DateTime UnixToDateTime (long unix);" />
 370       <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.DateTime UnixToDateTime(int64 unix) cil managed" />
 371       <MemberType>Method</MemberType>
 372       <AssemblyInfo>
 373         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 374         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 375         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 376       </AssemblyInfo>
 377       <Attributes>
 378         <Attribute>
 379           <AttributeName>System.Obsolete("Use Mono.Unix.Native.NativeConvert.ToDateTime")</AttributeName>
 380         </Attribute>
 381       </Attributes>
 382       <ReturnValue>
 383         <ReturnType>System.DateTime</ReturnType>
 384       </ReturnValue>
 385       <Parameters>
 386         <Parameter Name="unix" Type="System.Int64" />
 387       </Parameters>
 388       <Docs>
 389         <param name="unix">a <see cref="T:System.Int64" /></param>
 390         <summary>Convert unix epoch time value to <see cref="T:System.DateTime" /></summary>
 391         <returns>a <see cref="T:System.DateTime" /></returns>
 392         <remarks />
 393       </Docs>
 394     </Member>
 395   </Members>
 396 </Type>