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

   1 <Type Name="Flock" FullName="Mono.Unix.Native.Flock">
   2   <TypeSignature Language="C#" Value="public struct Flock : IEquatable&lt;Mono.Unix.Native.Flock&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.Flock&gt;</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <summary>
  22       <see cref="M:Mono.Unix.Native.Syscall.fcntl" />(2) advisory file locking information.</summary>
  23     <remarks>This can only be used with
  24     <see cref="F:Mono.Unix.Native.FcntlCommand.F_GETLK" />,
  25     <see cref="F:Mono.Unix.Native.FcntlCommand.F_SETLK" />, and
  26     <see cref="F:Mono.Unix.Native.FcntlCommand.F_SETLKW" />.
  27     </remarks>
  28     <altmember cref="M:Mono.Unix.Native.Syscall.fcntl(int,Mono.Unix.Native.FcntlCommand,Mono.Unix.Native.Flock&amp;)" />
  29   </Docs>
  30   <Members>
  31     <Member MemberName="Equals">
  32       <MemberSignature Language="C#" Value="public bool Equals (Mono.Unix.Native.Flock value);" />
  33       <MemberType>Method</MemberType>
  34       <ReturnValue>
  35         <ReturnType>System.Boolean</ReturnType>
  36       </ReturnValue>
  37       <Parameters>
  38         <Parameter Name="value" Type="Mono.Unix.Native.Flock" />
  39       </Parameters>
  40       <Docs>
  41         <param name="value">To be added.</param>
  42         <summary>To be added.</summary>
  43         <returns>To be added.</returns>
  44         <remarks>To be added.</remarks>
  45       </Docs>
  46       <AssemblyInfo>
  47         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  48         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  49       </AssemblyInfo>
  50     </Member>
  51     <Member MemberName="Equals">
  52       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
  53       <MemberType>Method</MemberType>
  54       <ReturnValue>
  55         <ReturnType>System.Boolean</ReturnType>
  56       </ReturnValue>
  57       <Parameters>
  58         <Parameter Name="obj" Type="System.Object" />
  59       </Parameters>
  60       <Docs>
  61         <param name="obj">To be added.</param>
  62         <summary>To be added.</summary>
  63         <returns>To be added.</returns>
  64         <remarks>To be added.</remarks>
  65       </Docs>
  66       <AssemblyInfo>
  67         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  68         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70     </Member>
  71     <Member MemberName="GetHashCode">
  72       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
  73       <MemberType>Method</MemberType>
  74       <ReturnValue>
  75         <ReturnType>System.Int32</ReturnType>
  76       </ReturnValue>
  77       <Parameters />
  78       <Docs>
  79         <summary>To be added.</summary>
  80         <returns>To be added.</returns>
  81         <remarks>To be added.</remarks>
  82       </Docs>
  83       <AssemblyInfo>
  84         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  85         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87     </Member>
  88     <Member MemberName="l_len">
  89       <MemberSignature Language="C#" Value="public long l_len;" />
  90       <MemberType>Field</MemberType>
  91       <ReturnValue>
  92         <ReturnType>System.Int64</ReturnType>
  93       </ReturnValue>
  94       <Docs>
  95         <summary>Length of file locking.  <c>l_len</c> = 0 means until enf of file.</summary>
  96         <remarks />
  97       </Docs>
  98       <AssemblyInfo>
  99         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 100         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 101       </AssemblyInfo>
 102     </Member>
 103     <Member MemberName="l_pid">
 104       <MemberSignature Language="C#" Value="public int l_pid;" />
 105       <MemberType>Field</MemberType>
 106       <ReturnValue>
 107         <ReturnType>System.Int32</ReturnType>
 108       </ReturnValue>
 109       <Docs>
 110         <summary>Lock owner.</summary>
 111         <remarks />
 112       </Docs>
 113       <AssemblyInfo>
 114         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 115         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 116       </AssemblyInfo>
 117     </Member>
 118     <Member MemberName="l_start">
 119       <MemberSignature Language="C#" Value="public long l_start;" />
 120       <MemberType>Field</MemberType>
 121       <ReturnValue>
 122         <ReturnType>System.Int64</ReturnType>
 123       </ReturnValue>
 124       <Docs>
 125         <summary>Starting offset.</summary>
 126         <remarks />
 127       </Docs>
 128       <AssemblyInfo>
 129         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 130         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 131       </AssemblyInfo>
 132     </Member>
 133     <Member MemberName="l_type">
 134       <MemberSignature Language="C#" Value="public Mono.Unix.Native.LockType l_type;" />
 135       <MemberType>Field</MemberType>
 136       <ReturnValue>
 137         <ReturnType>Mono.Unix.Native.LockType</ReturnType>
 138       </ReturnValue>
 139       <Docs>
 140         <summary>Lock type: read/write, etc.</summary>
 141         <remarks />
 142       </Docs>
 143       <Attributes>
 144         <Attribute>
 145           <AttributeName>System.CLSCompliant(false)</AttributeName>
 146         </Attribute>
 147       </Attributes>
 148       <AssemblyInfo>
 149         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 150         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 151       </AssemblyInfo>
 152     </Member>
 153     <Member MemberName="l_whence">
 154       <MemberSignature Language="C#" Value="public Mono.Unix.Native.SeekFlags l_whence;" />
 155       <MemberType>Field</MemberType>
 156       <ReturnValue>
 157         <ReturnType>Mono.Unix.Native.SeekFlags</ReturnType>
 158       </ReturnValue>
 159       <Docs>
 160         <summary>How to interpret <c>l_start</c>.</summary>
 161         <remarks />
 162       </Docs>
 163       <Attributes>
 164         <Attribute>
 165           <AttributeName>System.CLSCompliant(false)</AttributeName>
 166         </Attribute>
 167       </Attributes>
 168       <AssemblyInfo>
 169         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 170         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 171       </AssemblyInfo>
 172     </Member>
 173     <Member MemberName="op_Equality">
 174       <MemberSignature Language="C#" Value="public static bool op_Equality (Mono.Unix.Native.Flock lhs, Mono.Unix.Native.Flock rhs);" />
 175       <MemberType>Method</MemberType>
 176       <ReturnValue>
 177         <ReturnType>System.Boolean</ReturnType>
 178       </ReturnValue>
 179       <Parameters>
 180         <Parameter Name="lhs" Type="Mono.Unix.Native.Flock" />
 181         <Parameter Name="rhs" Type="Mono.Unix.Native.Flock" />
 182       </Parameters>
 183       <Docs>
 184         <param name="lhs">To be added.</param>
 185         <param name="rhs">To be added.</param>
 186         <summary>To be added.</summary>
 187         <returns>To be added.</returns>
 188         <remarks>To be added.</remarks>
 189       </Docs>
 190       <AssemblyInfo>
 191         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 192         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 193       </AssemblyInfo>
 194     </Member>
 195     <Member MemberName="op_Inequality">
 196       <MemberSignature Language="C#" Value="public static bool op_Inequality (Mono.Unix.Native.Flock lhs, Mono.Unix.Native.Flock rhs);" />
 197       <MemberType>Method</MemberType>
 198       <ReturnValue>
 199         <ReturnType>System.Boolean</ReturnType>
 200       </ReturnValue>
 201       <Parameters>
 202         <Parameter Name="lhs" Type="Mono.Unix.Native.Flock" />
 203         <Parameter Name="rhs" Type="Mono.Unix.Native.Flock" />
 204       </Parameters>
 205       <Docs>
 206         <param name="lhs">To be added.</param>
 207         <param name="rhs">To be added.</param>
 208         <summary>To be added.</summary>
 209         <returns>To be added.</returns>
 210         <remarks>To be added.</remarks>
 211       </Docs>
 212       <AssemblyInfo>
 213         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 214         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 215       </AssemblyInfo>
 216     </Member>
 217   </Members>
 218 </Type>