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

   1 <Type Name="Dirent" FullName="Mono.Unix.Native.Dirent">
   2   <TypeSignature Language="C#" Value="public sealed class Dirent : IEquatable&lt;Mono.Unix.Native.Dirent&gt;" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Dirent extends System.Object implements class System.IEquatable`1&lt;class Mono.Unix.Native.Dirent&gt;" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Posix</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <ThreadingSafetyStatement>
  11   All public static members of this type are safe for multithreaded operations.
  12   No instance members are guaranteed to be thread safe.
  13   </ThreadingSafetyStatement>
  14   <Base>
  15     <BaseTypeName>System.Object</BaseTypeName>
  16   </Base>
  17   <Interfaces>
  18     <Interface>
  19       <InterfaceName>System.IEquatable&lt;Mono.Unix.Native.Dirent&gt;</InterfaceName>
  20     </Interface>
  21   </Interfaces>
  22   <Docs>
  23     <summary>Information about a directory entry.</summary>
  24     <remarks>Not all of the members in this class are part of an actual
  25     standard; in particular, the only member that is consistently portable and
  26     will have a reliable value is <see cref="F:Mono.Unix.Native.Dirent.d_name" />.
  27     </remarks>
  28     <altmember cref="M:Mono.Unix.Native.Syscall.readdir" />
  29     <altmember cref="M:Mono.Unix.UnixDirectoryInfo.GetEntries" />
  30     <altmember cref="M:Mono.Unix.UnixDirectory.GetEntries" />
  31   </Docs>
  32   <Members>
  33     <Member MemberName=".ctor">
  34       <MemberSignature Language="C#" Value="public Dirent ();" />
  35       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  36       <MemberType>Constructor</MemberType>
  37       <AssemblyInfo>
  38         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  39         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  40         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  41       </AssemblyInfo>
  42       <Parameters />
  43       <Docs>
  44         <summary>Creates a <c>Dirent</c> instance.</summary>
  45         <remarks>Creating a <c>Dirent</c> has no effect on the filesystem.  To
  46         create a filesystem entry use
  47         <see cref="M:Mono.Unix.UnixFileSystemInfo.Create" />.</remarks>
  48       </Docs>
  49     </Member>
  50     <Member MemberName="d_ino">
  51       <MemberSignature Language="C#" Value="public ulong d_ino;" />
  52       <MemberSignature Language="ILAsm" Value=".field public unsigned int64 d_ino" />
  53       <MemberType>Field</MemberType>
  54       <AssemblyInfo>
  55         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  56         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  57         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  58       </AssemblyInfo>
  59       <Attributes>
  60         <Attribute>
  61           <AttributeName>System.CLSCompliant(false)</AttributeName>
  62         </Attribute>
  63       </Attributes>
  64       <ReturnValue>
  65         <ReturnType>System.UInt64</ReturnType>
  66       </ReturnValue>
  67       <Docs>
  68         <summary>Inode.</summary>
  69         <remarks>To be added.</remarks>
  70       </Docs>
  71     </Member>
  72     <Member MemberName="d_name">
  73       <MemberSignature Language="C#" Value="public string d_name;" />
  74       <MemberSignature Language="ILAsm" Value=".field public string d_name" />
  75       <MemberType>Field</MemberType>
  76       <AssemblyInfo>
  77         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  78         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  79         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  80       </AssemblyInfo>
  81       <ReturnValue>
  82         <ReturnType>System.String</ReturnType>
  83       </ReturnValue>
  84       <Docs>
  85         <summary>Filename.</summary>
  86         <remarks>To be added.</remarks>
  87       </Docs>
  88     </Member>
  89     <Member MemberName="d_off">
  90       <MemberSignature Language="C#" Value="public long d_off;" />
  91       <MemberSignature Language="ILAsm" Value=".field public int64 d_off" />
  92       <MemberType>Field</MemberType>
  93       <AssemblyInfo>
  94         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  95         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  96         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  97       </AssemblyInfo>
  98       <ReturnValue>
  99         <ReturnType>System.Int64</ReturnType>
 100       </ReturnValue>
 101       <Docs>
 102         <summary>To be added.</summary>
 103         <remarks>To be added.</remarks>
 104       </Docs>
 105     </Member>
 106     <Member MemberName="d_reclen">
 107       <MemberSignature Language="C#" Value="public ushort d_reclen;" />
 108       <MemberSignature Language="ILAsm" Value=".field public unsigned int16 d_reclen" />
 109       <MemberType>Field</MemberType>
 110       <AssemblyInfo>
 111         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 112         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 113         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 114       </AssemblyInfo>
 115       <Attributes>
 116         <Attribute>
 117           <AttributeName>System.CLSCompliant(false)</AttributeName>
 118         </Attribute>
 119       </Attributes>
 120       <ReturnValue>
 121         <ReturnType>System.UInt16</ReturnType>
 122       </ReturnValue>
 123       <Docs>
 124         <summary>Length of this record.</summary>
 125         <remarks>To be added.</remarks>
 126       </Docs>
 127     </Member>
 128     <Member MemberName="d_type">
 129       <MemberSignature Language="C#" Value="public byte d_type;" />
 130       <MemberSignature Language="ILAsm" Value=".field public unsigned int8 d_type" />
 131       <MemberType>Field</MemberType>
 132       <AssemblyInfo>
 133         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 135         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 136       </AssemblyInfo>
 137       <ReturnValue>
 138         <ReturnType>System.Byte</ReturnType>
 139       </ReturnValue>
 140       <Docs>
 141         <summary>File type.</summary>
 142         <remarks>This member is not part of POSIX; thus its value is not portable.</remarks>
 143       </Docs>
 144     </Member>
 145     <Member MemberName="Equals">
 146       <MemberSignature Language="C#" Value="public bool Equals (Mono.Unix.Native.Dirent value);" />
 147       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Mono.Unix.Native.Dirent value) cil managed" />
 148       <MemberType>Method</MemberType>
 149       <AssemblyInfo>
 150         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 151         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 152         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 153       </AssemblyInfo>
 154       <ReturnValue>
 155         <ReturnType>System.Boolean</ReturnType>
 156       </ReturnValue>
 157       <Parameters>
 158         <Parameter Name="value" Type="Mono.Unix.Native.Dirent" />
 159       </Parameters>
 160       <Docs>
 161         <param name="value">To be added.</param>
 162         <summary>To be added.</summary>
 163         <returns>To be added.</returns>
 164         <remarks>To be added.</remarks>
 165       </Docs>
 166     </Member>
 167     <Member MemberName="Equals">
 168       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
 169       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
 170       <MemberType>Method</MemberType>
 171       <AssemblyInfo>
 172         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 173         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 174         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 175       </AssemblyInfo>
 176       <ReturnValue>
 177         <ReturnType>System.Boolean</ReturnType>
 178       </ReturnValue>
 179       <Parameters>
 180         <Parameter Name="obj" Type="System.Object" />
 181       </Parameters>
 182       <Docs>
 183         <param name="obj">To be added.</param>
 184         <summary>To be added.</summary>
 185         <returns>To be added.</returns>
 186         <remarks>To be added.</remarks>
 187       </Docs>
 188     </Member>
 189     <Member MemberName="GetHashCode">
 190       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
 191       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
 192       <MemberType>Method</MemberType>
 193       <AssemblyInfo>
 194         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 195         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 196         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 197       </AssemblyInfo>
 198       <ReturnValue>
 199         <ReturnType>System.Int32</ReturnType>
 200       </ReturnValue>
 201       <Parameters />
 202       <Docs>
 203         <summary>To be added.</summary>
 204         <returns>To be added.</returns>
 205         <remarks>To be added.</remarks>
 206       </Docs>
 207     </Member>
 208     <Member MemberName="op_Equality">
 209       <MemberSignature Language="C#" Value="public static bool op_Equality (Mono.Unix.Native.Dirent lhs, Mono.Unix.Native.Dirent rhs);" />
 210       <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(class Mono.Unix.Native.Dirent lhs, class Mono.Unix.Native.Dirent rhs) cil managed" />
 211       <MemberType>Method</MemberType>
 212       <AssemblyInfo>
 213         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 214         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 215         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 216       </AssemblyInfo>
 217       <ReturnValue>
 218         <ReturnType>System.Boolean</ReturnType>
 219       </ReturnValue>
 220       <Parameters>
 221         <Parameter Name="lhs" Type="Mono.Unix.Native.Dirent" />
 222         <Parameter Name="rhs" Type="Mono.Unix.Native.Dirent" />
 223       </Parameters>
 224       <Docs>
 225         <param name="lhs">To be added.</param>
 226         <param name="rhs">To be added.</param>
 227         <summary>To be added.</summary>
 228         <returns>To be added.</returns>
 229         <remarks>To be added.</remarks>
 230       </Docs>
 231     </Member>
 232     <Member MemberName="op_Inequality">
 233       <MemberSignature Language="C#" Value="public static bool op_Inequality (Mono.Unix.Native.Dirent lhs, Mono.Unix.Native.Dirent rhs);" />
 234       <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(class Mono.Unix.Native.Dirent lhs, class Mono.Unix.Native.Dirent rhs) cil managed" />
 235       <MemberType>Method</MemberType>
 236       <AssemblyInfo>
 237         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 238         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 239         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 240       </AssemblyInfo>
 241       <ReturnValue>
 242         <ReturnType>System.Boolean</ReturnType>
 243       </ReturnValue>
 244       <Parameters>
 245         <Parameter Name="lhs" Type="Mono.Unix.Native.Dirent" />
 246         <Parameter Name="rhs" Type="Mono.Unix.Native.Dirent" />
 247       </Parameters>
 248       <Docs>
 249         <param name="lhs">To be added.</param>
 250         <param name="rhs">To be added.</param>
 251         <summary>To be added.</summary>
 252         <returns>To be added.</returns>
 253         <remarks>To be added.</remarks>
 254       </Docs>
 255     </Member>
 256     <Member MemberName="ToString">
 257       <MemberSignature Language="C#" Value="public override string ToString ();" />
 258       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 259       <MemberType>Method</MemberType>
 260       <AssemblyInfo>
 261         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 262         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 263         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 264       </AssemblyInfo>
 265       <ReturnValue>
 266         <ReturnType>System.String</ReturnType>
 267       </ReturnValue>
 268       <Parameters />
 269       <Docs>
 270         <summary>To be added.</summary>
 271         <returns>To be added.</returns>
 272         <remarks>To be added.</remarks>
 273       </Docs>
 274     </Member>
 275   </Members>
 276 </Type>