mcs/class/Mono.Posix/Documentation/en/Mono.Unix/UnixIOException.xml

   1 <Type Name="UnixIOException" FullName="Mono.Unix.UnixIOException">
   2   <TypeSignature Language="C#" Value="public class UnixIOException : System.IO.IOException" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit UnixIOException extends System.IO.IOException" />
   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>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  11   <Base>
  12     <BaseTypeName>System.IO.IOException</BaseTypeName>
  13   </Base>
  14   <Interfaces />
  15   <Docs>
  16     <summary>Represents errors that are generated from Unix system calls.</summary>
  17     <remarks>
  18       <para>
  19                                 If an exception is generated due to an operating system-level error
  20                                 (as opposed to invalid arguments or some fully managed reason), the
  21                                 exception thrown will either inherit from
  22                                 <see cref="T:Mono.Unix.UnixIOException" />, or the
  23                                 <see cref="P:System.Exception.InnerException" /> property will be a
  24                                 type inheriting from <c>UnixIOException</c>.  In either case, the
  25                                 <see cref="P:Mono.Unix.UnixIOException.ErrorCode" /> property will
  26                                 contain the underlying error number that generated the exception.
  27                                 This error number can be used to look up additional information if
  28                                 necessary.
  29                         </para>
  30     </remarks>
  31   </Docs>
  32   <Members>
  33     <Member MemberName=".ctor">
  34       <MemberSignature Language="C#" Value="public UnixIOException ();" />
  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>
  45           Constructs and initializes a new instance of the
  46           <see cref="T:Mono.Unix.UnixIOException" /> class using the last
  47           error generated.
  48         </summary>
  49         <remarks>
  50           <para>
  51             This constructor initializes the
  52             <see cref="P:Mono.Unix.UnixIOException.NativeErrorCode" />
  53             property to the value returned by
  54             <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error" />,
  55             and initializes the
  56             <see cref="P:System.Exception.Message" /> property to a
  57             system-supplied message that describes the last error.
  58           </para>
  59           <para>
  60             The <see cref="P:System.Exception.InnerException" /> property is
  61             initialized to <see langword="null" />.
  62           </para>
  63         </remarks>
  64         <exception cref="T:System.ArgumentOutOfRangeException">
  65           The value returned by
  66           <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error" />
  67           is not a valid error value on this platform.
  68         </exception>
  69         <altmember cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error" />
  70       </Docs>
  71     </Member>
  72     <Member MemberName=".ctor">
  73       <MemberSignature Language="C#" Value="public UnixIOException (Mono.Unix.Native.Errno errno);" />
  74       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Mono.Unix.Native.Errno errno) cil managed" />
  75       <MemberType>Constructor</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       <Parameters>
  82         <Parameter Name="errno" Type="Mono.Unix.Native.Errno" />
  83       </Parameters>
  84       <Docs>
  85         <param name="errno">
  86           A <see cref="T:Mono.Unix.Native.Errno" /> that specifies which
  87           error occurred.
  88         </param>
  89         <summary>
  90           Constructs and initializes a new instance of the
  91           <see cref="T:Mono.Unix.UnixIOException" /> class using the specified
  92           error value.
  93         </summary>
  94         <remarks>
  95           <para>
  96             This constructor initializes the
  97             <see cref="P:Mono.Unix.UnixIOException.ErrorCode" />
  98             property to <paramref name="errno" />, and initializes the
  99             <see cref="P:System.Exception.Message" /> property to a
 100             system-supplied message that describes <paramref name="errno" />.
 101           </para>
 102           <para>
 103             The <see cref="P:System.Exception.InnerException" /> property is
 104             initialized to <see langword="null" />.
 105           </para>
 106         </remarks>
 107         <exception cref="T:System.ArgumentOutOfRangeException">
 108           The value <paramref name="errno" />
 109           is not a valid error value on this platform.
 110         </exception>
 111         <altmember cref="M:Mono.Unix.UnixMarshal.GetErrorDescription" />
 112       </Docs>
 113     </Member>
 114     <Member MemberName=".ctor">
 115       <MemberSignature Language="C#" Value="public UnixIOException (int errno);" />
 116       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 errno) cil managed" />
 117       <MemberType>Constructor</MemberType>
 118       <AssemblyInfo>
 119         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 120         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 121         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 122       </AssemblyInfo>
 123       <Parameters>
 124         <Parameter Name="errno" Type="System.Int32" />
 125       </Parameters>
 126       <Docs>
 127         <param name="errno">
 128           A <see cref="T:System.Int32" /> that specifies which error occurred.
 129         </param>
 130         <summary>
 131           Constructs and initializes a new instance of the
 132           <see cref="T:Mono.Unix.UnixIOException" /> class using the
 133           specified error value.
 134         </summary>
 135         <remarks>
 136           <para>
 137             This constructor initializes the
 138             <see cref="P:Mono.Unix.UnixIOException.NativeErrorCode" />
 139             property to <paramref name="errno" />, and initializes the
 140             <see cref="P:System.Exception.Message" /> property to a
 141             system-supplied message that describes <paramref name="errno" />.
 142           </para>
 143           <para>
 144             The <see cref="P:System.Exception.InnerException" /> property is
 145             initialized to <see langword="null" />.
 146           </para>
 147         </remarks>
 148         <exception cref="T:System.ArgumentOutOfRangeException">
 149           The value <paramref name="errno" />
 150           is not a valid error value on this platform.
 151         </exception>
 152         <altmember cref="M:Mono.Unix.UnixMarshal.GetErrorDescription" />
 153       </Docs>
 154     </Member>
 155     <Member MemberName=".ctor">
 156       <MemberSignature Language="C#" Value="public UnixIOException (string message);" />
 157       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message) cil managed" />
 158       <MemberType>Constructor</MemberType>
 159       <AssemblyInfo>
 160         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 161         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 162         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 163       </AssemblyInfo>
 164       <Parameters>
 165         <Parameter Name="message" Type="System.String" />
 166       </Parameters>
 167       <Docs>
 168         <param name="message">
 169           A <see cref="T:System.String" /> that describes the error.  The
 170           contents of <paramref name="message" /> is intended to be understood
 171           by humans.  The caller of this constructor is required to ensure
 172           that this string has been localized for the current system culture.
 173         </param>
 174         <summary>
 175           Constructs and initializes a new instance of the
 176           <see cref="T:Mono.Unix.UnixIOException" /> class using the specified
 177           message.
 178         </summary>
 179         <remarks>
 180           <para>
 181             This constructor initializes the
 182             <see cref="P:Mono.Unix.UnixIOException.ErrorCode" />
 183             property to 0, and initializes the
 184             <see cref="P:System.Exception.Message" /> property to
 185             <paramref name="message" />.
 186           </para>
 187           <para>
 188             The <see cref="P:System.Exception.InnerException" /> property is
 189             initialized to <see langword="null" />.
 190           </para>
 191         </remarks>
 192       </Docs>
 193     </Member>
 194     <Member MemberName=".ctor">
 195       <MemberSignature Language="C#" Value="public UnixIOException (Mono.Unix.Native.Errno errno, Exception inner);" />
 196       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Mono.Unix.Native.Errno errno, class System.Exception inner) cil managed" />
 197       <MemberType>Constructor</MemberType>
 198       <AssemblyInfo>
 199         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 200         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 201         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 202       </AssemblyInfo>
 203       <Parameters>
 204         <Parameter Name="errno" Type="Mono.Unix.Native.Errno" />
 205         <Parameter Name="inner" Type="System.Exception" />
 206       </Parameters>
 207       <Docs>
 208         <param name="errno">
 209           A <see cref="T:System.Int32" /> that specifies which error occurred.
 210         </param>
 211         <param name="inner">
 212           An instance of <see cref="T:System.Exception" /> that is the cause
 213           of the current exception.  If <paramref name="inner" /> is
 214           non-<see langword="null" />, then the current Exception was raised
 215           in a catch block handling <paramref name="inner" />.
 216         </param>
 217         <summary>
 218           Constructs and initializes a new instance of the
 219           <see cref="T:Mono.Unix.UnixIOException" /> class using the specified
 220           error value and nested exception.
 221         </summary>
 222         <remarks>
 223           <para>
 224             This constructor initializes the
 225             <see cref="P:Mono.Unix.UnixIOException.NativeErrorCode" />
 226             property to <paramref name="errno" />, initializes the
 227             <see cref="P:System.Exception.Message" /> property to a
 228             system-supplied message that describes <paramref name="errno" />,
 229             and initializes the
 230             <see cref="P:System.Exception.InnerException" /> property to
 231             <paramref name="inner" />.
 232           </para>
 233         </remarks>
 234         <exception cref="T:System.ArgumentOutOfRangeException">
 235           The value <paramref name="errno" />
 236           is not a valid error value on this platform.
 237         </exception>
 238         <altmember cref="M:Mono.Unix.UnixMarshal.GetErrorDescription" />
 239       </Docs>
 240     </Member>
 241     <Member MemberName=".ctor">
 242       <MemberSignature Language="C#" Value="public UnixIOException (int errno, Exception inner);" />
 243       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 errno, class System.Exception inner) cil managed" />
 244       <MemberType>Constructor</MemberType>
 245       <AssemblyInfo>
 246         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 247         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 248         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 249       </AssemblyInfo>
 250       <Parameters>
 251         <Parameter Name="errno" Type="System.Int32" />
 252         <Parameter Name="inner" Type="System.Exception" />
 253       </Parameters>
 254       <Docs>
 255         <param name="errno">
 256           A <see cref="T:System.Int32" /> that specifies which error occurred.
 257         </param>
 258         <param name="inner">
 259           An instance of <see cref="T:System.Exception" /> that is the cause
 260           of the current exception.  If <paramref name="inner" /> is
 261           non-<see langword="null" />, then the current Exception was raised
 262           in a catch block handling <paramref name="inner" />.
 263         </param>
 264         <summary>
 265           Constructs and initializes a new instance of the
 266           <see cref="T:Mono.Unix.UnixIOException" /> class using the
 267           sxpecified error value and nested exception.
 268         </summary>
 269         <remarks>
 270           <para>
 271             This constructor initializes the
 272             <see cref="P:Mono.Unix.UnixIOException.NativeErrorCode" />
 273             property to <paramref name="errno" />, initializes the
 274             <see cref="P:System.Exception.Message" /> property to a
 275             system-supplied message that describes <paramref name="errno" />,
 276             and initializes the
 277             <see cref="P:System.Exception.InnerException" /> property to
 278             <paramref name="inner" />.
 279           </para>
 280         </remarks>
 281         <exception cref="T:System.ArgumentOutOfRangeException">
 282           The value <paramref name="errno" />
 283           is not a valid error value on this platform.
 284         </exception>
 285         <altmember cref="M:Mono.Unix.UnixMarshal.GetErrorDescription" />
 286       </Docs>
 287     </Member>
 288     <Member MemberName=".ctor">
 289       <MemberSignature Language="C#" Value="protected UnixIOException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
 290       <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
 291       <MemberType>Constructor</MemberType>
 292       <AssemblyInfo>
 293         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 294         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 295         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 296       </AssemblyInfo>
 297       <Parameters>
 298         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
 299         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
 300       </Parameters>
 301       <Docs>
 302         <param name="info">
 303           A <see cref="T:System.Runtime.Serialization.SerializationInfo" />
 304           instance.
 305         </param>
 306         <param name="context">
 307           A <see cref="System.Runtime.Serialization.StreamingContext" />
 308           instance.
 309         </param>
 310         <summary>Serialization constructor.</summary>
 311         <remarks>This constructor is intended to be used by the system for
 312           serialization purposes.</remarks>
 313       </Docs>
 314     </Member>
 315     <Member MemberName=".ctor">
 316       <MemberSignature Language="C#" Value="public UnixIOException (string message, Exception inner);" />
 317       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception inner) cil managed" />
 318       <MemberType>Constructor</MemberType>
 319       <AssemblyInfo>
 320         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 321         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 322         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 323       </AssemblyInfo>
 324       <Parameters>
 325         <Parameter Name="message" Type="System.String" />
 326         <Parameter Name="inner" Type="System.Exception" />
 327       </Parameters>
 328       <Docs>
 329         <param name="message">
 330           A <see cref="T:System.String" /> that describes the error.  The
 331           contents of <paramref name="message" /> is intended to be understood
 332           by humans.  The caller of this constructor is required to ensure
 333           that this string has been localized for the current system culture.
 334         </param>
 335         <param name="inner">
 336           An instance of <see cref="T:System.Exception" /> that is the cause
 337           of the current exception.  If <paramref name="inner" /> is
 338           non-<see langword="null" />, then the current Exception was raised
 339           in a catch block handling <paramref name="inner" />.
 340         </param>
 341         <summary>
 342           Constructs and initializes a new instance of the
 343           <see cref="T:Mono.Unix.UnixIOException" /> class using the specified
 344           error value and nested exception.
 345         </summary>
 346         <remarks>
 347           <para>
 348             This constructor initializes the
 349             <see cref="P:Mono.Unix.UnixIOException.ErrorCode" />
 350             property to 0, initializes the
 351             <see cref="P:System.Exception.Message" /> property to
 352             <paramref name="message" />, and initializes the
 353             <see cref="P:System.Exception.InnerException" /> property
 354             to <paramref name="inner" />.
 355           </para>
 356         </remarks>
 357       </Docs>
 358     </Member>
 359     <Member MemberName="ErrorCode">
 360       <MemberSignature Language="C#" Value="public Mono.Unix.Native.Errno ErrorCode { get; }" />
 361       <MemberSignature Language="ILAsm" Value=".property instance valuetype Mono.Unix.Native.Errno ErrorCode" />
 362       <MemberType>Property</MemberType>
 363       <AssemblyInfo>
 364         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 365         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 366         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 367       </AssemblyInfo>
 368       <ReturnValue>
 369         <ReturnType>Mono.Unix.Native.Errno</ReturnType>
 370       </ReturnValue>
 371       <Docs>
 372         <summary>Gets the logical error value specified in the constructor.</summary>
 373         <value>
 374           A <see cref="T:Mono.Unix.Native.Errno" /> value describing the error
 375           specified in the constructor.
 376         </value>
 377         <remarks>
 378           <para>
 379             This is the translated value of
 380             <see cref="P:Mono.Unix.UnixIOException.NativeErrorCode" />.
 381           </para>
 382         </remarks>
 383         <altmember cref="M:Mono.Unix.Native.NativeConvert.ToErrno" />
 384       </Docs>
 385     </Member>
 386     <Member MemberName="NativeErrorCode">
 387       <MemberSignature Language="C#" Value="public int NativeErrorCode { get; }" />
 388       <MemberSignature Language="ILAsm" Value=".property instance int32 NativeErrorCode" />
 389       <MemberType>Property</MemberType>
 390       <AssemblyInfo>
 391         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 392         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 393         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 394       </AssemblyInfo>
 395       <ReturnValue>
 396         <ReturnType>System.Int32</ReturnType>
 397       </ReturnValue>
 398       <Docs>
 399         <summary>Gets the native error value specified in the constructor.</summary>
 400         <value>
 401           A <see cref="T:System.Int32" /> containing the native error value
 402           specified in the constructor.
 403         </value>
 404         <remarks>
 405           <para>
 406             The native error value and the value of
 407             <see cref="P:Mono.Unix.UnixIOException.ErrorCode" /> are not going
 408             to be the same on all platforms.
 409           </para>
 410         </remarks>
 411       </Docs>
 412     </Member>
 413   </Members>
 414 </Type>