mcs/class/corlib/Documentation/en/System/NotFiniteNumberException.xml

   1 <Type Name="NotFiniteNumberException" FullName="System.NotFiniteNumberException" FullNameSP="System_NotFiniteNumberException" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class public serializable NotFiniteNumberException extends System.ArithmeticException" />
   3   <TypeSignature Language="C#" Value="public class NotFiniteNumberException : ArithmeticException" />
   4   <MemberOfLibrary>ExtendedNumerics</MemberOfLibrary>
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  11   </AssemblyInfo>
  12   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  13   <Base>
  14     <BaseTypeName>System.ArithmeticException</BaseTypeName>
  15   </Base>
  16   <Interfaces />
  17   <Docs>
  18     <summary>
  19       <para> Represents the error that occurs when an arithmetic operation cannot be performed on a floating-point value that
  20       is not a finite number.</para>
  21     </summary>
  22     <remarks>
  23       <para>This exception is thrown when an operand of an arithmetic operation is, and
  24       is not permitted to be, one of the following:</para>
  25       <list type="bullet">
  26         <item>
  27           <term> Positive infinity</term>
  28         </item>
  29         <item>
  30           <term> Negative infinity</term>
  31         </item>
  32         <item>
  33           <term> NaN (Not-a-Number)</term>
  34         </item>
  35       </list>
  36       <para>
  37         <block subset="none" type="note">Operations involving <see cref="T:System.Double" /> or <see cref="T:System.Single" /> operations throw
  38 this exception.</block>
  39       </para>
  40     </remarks>
  41   </Docs>
  42   <Members>
  43     <Member MemberName=".ctor">
  44       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor()" />
  45       <MemberSignature Language="C#" Value="public NotFiniteNumberException ();" />
  46       <MemberType>Constructor</MemberType>
  47       <ReturnValue />
  48       <Parameters />
  49       <Docs>
  50         <summary>
  51           <para>Constructs and initializes a new instance of the <see cref="T:System.NotFiniteNumberException" /> class.</para>
  52         </summary>
  53         <remarks>
  54           <para>This constructor initializes the <see cref="!:System.NotFiniteNumberException.Message" /> property of the new instance to a system-supplied
  55    message that describes the error, such as "The number encountered was not a
  56    finite quantity." This message takes into account the current system culture. </para>
  57           <para>This constructor initializes the <see cref="P:System.NotFiniteNumberException.OffendingNumber" /> property to zero. The <see cref="!:System.NotFiniteNumberException.InnerException" />
  58 property is initialized to <see langword="null" /> .</para>
  59         </remarks>
  60       </Docs>
  61       <Excluded>0</Excluded>
  62       <AssemblyInfo>
  63         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  64         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  65         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  66       </AssemblyInfo>
  67     </Member>
  68     <Member MemberName=".ctor">
  69       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(float64 offendingNumber)" />
  70       <MemberSignature Language="C#" Value="public NotFiniteNumberException (double offendingNumber);" />
  71       <MemberType>Constructor</MemberType>
  72       <ReturnValue />
  73       <Parameters>
  74         <Parameter Name="offendingNumber" Type="System.Double" />
  75       </Parameters>
  76       <Docs>
  77         <param name="offendingNumber">A <see cref="T:System.Double" /> that specifies the value of the argument that caused the Exception.</param>
  78         <summary>
  79           <para>Constructs and initializes a new instance of the <see cref="T:System.NotFiniteNumberException" />
  80 class.</para>
  81         </summary>
  82         <remarks>
  83           <para>This constructor initializes the <see cref="!:System.NotFiniteNumberException.Message" /> property of the new instance to a system-supplied
  84    message that describes the error, such as "The number encountered was not a
  85    finite quantity." This message takes into account the current system
  86    culture.</para>
  87           <para>This constructor initializes the <see cref="P:System.NotFiniteNumberException.OffendingNumber" /> property using <paramref name="offendingNumber" />. The <see cref="!:System.NotFiniteNumberException.InnerException" /> property is initialized to
  88 <see langword="null" /> .</para>
  89         </remarks>
  90       </Docs>
  91       <Excluded>0</Excluded>
  92       <AssemblyInfo>
  93         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  94         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  95         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  96       </AssemblyInfo>
  97     </Member>
  98     <Member MemberName=".ctor">
  99       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message)" />
 100       <MemberSignature Language="C#" Value="public NotFiniteNumberException (string message);" />
 101       <MemberType>Constructor</MemberType>
 102       <ReturnValue />
 103       <Parameters>
 104         <Parameter Name="message" Type="System.String" />
 105       </Parameters>
 106       <Docs>
 107         <param name="message">A <see cref="T:System.String" /> that describes the error. The content of <paramref name="message" /> is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
 108         <summary>
 109           <para>Constructs and initializes a new instance of the <see cref="T:System.NotFiniteNumberException" />
 110 class.</para>
 111         </summary>
 112         <remarks>
 113           <para>This constructor initializes the <see cref="!:System.NotFiniteNumberException.Message" /> property of the new instance
 114    using <paramref name="message" /> , and
 115    initializes the <see cref="P:System.NotFiniteNumberException.OffendingNumber" />
 116    property to zero. If <paramref name="message" /> is <see langword="null" />, the <see cref="!:System.NotFiniteNumberException.Message" /> property is initialized to the system-supplied message
 117    provided by the constructor that takes no arguments. </para>
 118           <para> The <see cref="!:System.NotFiniteNumberException.InnerException" />
 119 property is initialized to <see langword="null" /> .</para>
 120         </remarks>
 121       </Docs>
 122       <Excluded>0</Excluded>
 123       <AssemblyInfo>
 124         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 125         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 126         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 127       </AssemblyInfo>
 128     </Member>
 129     <Member MemberName=".ctor">
 130       <MemberSignature Language="C#" Value="protected NotFiniteNumberException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
 131       <MemberType>Constructor</MemberType>
 132       <Parameters>
 133         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
 134         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
 135       </Parameters>
 136       <Docs>
 137         <param name="info">To be added.</param>
 138         <param name="context">To be added.</param>
 139         <summary>To be added.</summary>
 140         <remarks>To be added.</remarks>
 141       </Docs>
 142       <AssemblyInfo>
 143         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 144         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 145         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 146       </AssemblyInfo>
 147     </Member>
 148     <Member MemberName=".ctor">
 149       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message, float64 offendingNumber)" />
 150       <MemberSignature Language="C#" Value="public NotFiniteNumberException (string message, double offendingNumber);" />
 151       <MemberType>Constructor</MemberType>
 152       <ReturnValue />
 153       <Parameters>
 154         <Parameter Name="message" Type="System.String" />
 155         <Parameter Name="offendingNumber" Type="System.Double" />
 156       </Parameters>
 157       <Docs>
 158         <param name="message">A <see cref="T:System.String" /> that describes the error. The content of <paramref name="message" /> is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
 159         <param name="offendingNumber">A <see cref="T:System.Double" /> that specifies the value of the argument that caused the current Exception.</param>
 160         <summary>
 161           <para>Constructs a new instance of the <see cref="T:System.NotFiniteNumberException" />
 162 class.</para>
 163         </summary>
 164         <remarks>
 165           <para>This constructor initializes the <see cref="!:System.NotFiniteNumberException.Message" /> property of the new instance using <paramref name="message" /> and
 166    the <see langword="OffendingNumber" /> property using <paramref name="offendingNumber" />. If <paramref name="message" /> is
 167 <see langword="null" />, the <see cref="!:System.NotFiniteNumberException.Message" /> property is initialized to the system-supplied message
 168    provided by the constructor that takes no arguments.</para>
 169           <para> The <see cref="!:System.NotFiniteNumberException.InnerException" /> property is initialized to
 170 <see langword="null" /> .</para>
 171         </remarks>
 172       </Docs>
 173       <Excluded>0</Excluded>
 174       <AssemblyInfo>
 175         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 176         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 177         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 178       </AssemblyInfo>
 179     </Member>
 180     <Member MemberName=".ctor">
 181       <MemberSignature Language="C#" Value="public NotFiniteNumberException (string message, Exception innerException);" />
 182       <MemberType>Constructor</MemberType>
 183       <Parameters>
 184         <Parameter Name="message" Type="System.String" />
 185         <Parameter Name="innerException" Type="System.Exception" />
 186       </Parameters>
 187       <Docs>
 188         <param name="message">To be added.</param>
 189         <param name="innerException">To be added.</param>
 190         <summary>To be added.</summary>
 191         <remarks>To be added.</remarks>
 192         <since version=".NET 2.0" />
 193       </Docs>
 194       <AssemblyInfo>
 195         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 196         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 197       </AssemblyInfo>
 198     </Member>
 199     <Member MemberName=".ctor">
 200       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string message, float64 offendingNumber, class System.Exception innerException)" />
 201       <MemberSignature Language="C#" Value="public NotFiniteNumberException (string message, double offendingNumber, Exception innerException);" />
 202       <MemberType>Constructor</MemberType>
 203       <ReturnValue />
 204       <Parameters>
 205         <Parameter Name="message" Type="System.String" />
 206         <Parameter Name="offendingNumber" Type="System.Double" />
 207         <Parameter Name="innerException" Type="System.Exception" />
 208       </Parameters>
 209       <Docs>
 210         <param name="message">A <see cref="T:System.String" /> that describes the error. The content of <paramref name="message" /> is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture.</param>
 211         <param name="offendingNumber">A <see cref="T:System.Double" /> that specifies the value of the argument that caused the current exception.</param>
 212         <param name="innerException">An instance of <see cref="T:System.Exception" /> that is the cause of the current exception. If <paramref name="innerException" /> is non-null, then the current exception was raised in a catch block handling <paramref name="innerException" />.</param>
 213         <summary>
 214           <para>Constructs and initializes a new instance of the <see cref="T:System.NotFiniteNumberException" />
 215 class.</para>
 216         </summary>
 217         <remarks>
 218           <para>This constructor initializes the <see cref="!:System.NotFiniteNumberException.Message" /> property of the new instance using <paramref name="message" />, the
 219 <see cref="P:System.NotFiniteNumberException.OffendingNumber" /> property using <paramref name="offendingNumber" />, and the <see cref="!:System.NotFiniteNumberException.InnerException" /> property using <paramref name="innerException" />. If <paramref name="message" /> is
 220 <see langword="null" />, the <see cref="!:System.NotFiniteNumberException.Message" /> property is initialized to the system-supplied message
 221    provided by the constructor that takes no arguments. </para>
 222           <para>
 223             <block subset="none" type="note">For information on inner exceptions, see
 224 <see cref="P:System.Exception.InnerException" />.</block>
 225           </para>
 226         </remarks>
 227       </Docs>
 228       <Excluded>0</Excluded>
 229       <AssemblyInfo>
 230         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 231         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 232         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 233       </AssemblyInfo>
 234     </Member>
 235     <Member MemberName="GetObjectData">
 236       <MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
 237       <MemberType>Method</MemberType>
 238       <ReturnValue>
 239         <ReturnType>System.Void</ReturnType>
 240       </ReturnValue>
 241       <Parameters>
 242         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
 243         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
 244       </Parameters>
 245       <Docs>
 246         <param name="info">To be added.</param>
 247         <param name="context">To be added.</param>
 248         <summary>To be added.</summary>
 249         <remarks>To be added.</remarks>
 250       </Docs>
 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     </Member>
 257     <Member MemberName="OffendingNumber">
 258       <MemberSignature Language="ILASM" Value=".property float64 OffendingNumber { public hidebysig specialname instance float64 get_OffendingNumber() }" />
 259       <MemberSignature Language="C#" Value="public double OffendingNumber { get; }" />
 260       <MemberType>Property</MemberType>
 261       <ReturnValue>
 262         <ReturnType>System.Double</ReturnType>
 263       </ReturnValue>
 264       <Parameters />
 265       <Docs>
 266         <summary>
 267           <para> Gets the value of the argument that caused the current Exception.</para>
 268         </summary>
 269         <value>
 270           <para>A <see cref="T:System.Double" /> that contains the invalid value.</para>
 271         </value>
 272         <remarks>
 273           <para>This property is read-only.</para>
 274           <para>The <see cref="P:System.NotFiniteNumberException.OffendingNumber" />
 275 property returns the same value as was passed into the
 276 constructor, or zero if no value was supplied.</para>
 277         </remarks>
 278       </Docs>
 279       <Excluded>0</Excluded>
 280       <AssemblyInfo>
 281         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 282         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 283         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 284       </AssemblyInfo>
 285     </Member>
 286   </Members>
 287   <TypeExcluded>0</TypeExcluded>
 288   <Attributes>
 289     <Attribute>
 290       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
 291     </Attribute>
 292   </Attributes>
 293 </Type>