mcs/class/Mono.Options/Documentation/en/Mono.Options/OptionException.xml

   1 <Type Name="OptionException" FullName="Mono.Options.OptionException">
   2   <TypeSignature Language="C#" Value="public class OptionException : Exception" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit OptionException extends System.Exception" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Options</AssemblyName>
   6     <AssemblyVersion>0.2.0.0</AssemblyVersion>
   7     <AssemblyVersion>0.2.1.0</AssemblyVersion>
   8     <AssemblyVersion>0.2.2.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <Base>
  11     <BaseTypeName>System.Exception</BaseTypeName>
  12   </Base>
  13   <Interfaces />
  14   <Docs>
  15     <summary>Represents the error that occurs when there is an error parsing
  16       an <see cref="T:Mono.Options.Option" />.</summary>
  17     <remarks>
  18       <para>Instances of this class are thrown when:</para>
  19       <list type="bullet">
  20         <item>
  21           <term>There is an exception generated converting a string to an
  22         object of type <typeparamref name="T" /> within the callback
  23         registered by
  24         <see cref="M:Mono.Options.OptionSet.Add``1(System.String,System.String,System.Action{``0})" />
  25         (and related overloads).
  26         </term>
  27         </item>
  28         <item>
  29           <term>
  30             <see cref="M:Mono.Options.Option.Parse``1(System.String,Mono.Options.OptionContext)" />
  31           could not convert a <see cref="T:System.String" /> to an object
  32           of type <typeparamref name="T" />.
  33         </term>
  34         </item>
  35         <item>
  36           <term>
  37           An option with a <see cref="P:Mono.Options.Option.OptionValueType" />
  38           value of <see cref="F:Mono.Options.OptionValueType.Required" />
  39           does not have a value (usually because the start of the option was
  40           the last argument).
  41         </term>
  42         </item>
  43       </list>
  44     </remarks>
  45   </Docs>
  46   <Members>
  47     <Member MemberName=".ctor">
  48       <MemberSignature Language="C#" Value="public OptionException ();" />
  49       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  50       <MemberType>Constructor</MemberType>
  51       <AssemblyInfo>
  52         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  53         <AssemblyVersion>0.2.2.0</AssemblyVersion>
  54       </AssemblyInfo>
  55       <Parameters />
  56       <Docs>
  57         <summary>To be added.</summary>
  58         <remarks>To be added.</remarks>
  59       </Docs>
  60     </Member>
  61     <Member MemberName=".ctor">
  62       <MemberSignature Language="C#" Value="protected OptionException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
  63       <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" />
  64       <MemberType>Constructor</MemberType>
  65       <AssemblyInfo>
  66         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  67         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  68         <AssemblyVersion>0.2.2.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <Parameters>
  71         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
  72         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
  73       </Parameters>
  74       <Docs>
  75         <param name="info">
  76           The <see cref="T:System.Runtime.Serialization.SerializationInfo" />
  77           that holds the serialized object data about the exception being
  78           thrown.
  79         </param>
  80         <param name="context">
  81           The <see cref="T:System.Runtime.Serialization.StreamingContext" />
  82           that contains contextual information about the source or
  83           destination.
  84         </param>
  85         <summary>
  86           Initializes a new instance of the
  87           <see cref="T:Mono.Options.OptionException" /> class with serialized
  88           data.
  89         </summary>
  90         <remarks>
  91           This constructor is called during deserialization to reconstitute the
  92           exception object transmitted over a stream, e.g. from Remoting.
  93         </remarks>
  94         <altmember cref="M:Mono.Options.OptionException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  95       </Docs>
  96     </Member>
  97     <Member MemberName=".ctor">
  98       <MemberSignature Language="C#" Value="public OptionException (string message, string optionName);" />
  99       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, string optionName) cil managed" />
 100       <MemberType>Constructor</MemberType>
 101       <AssemblyInfo>
 102         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 103         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 104         <AssemblyVersion>0.2.2.0</AssemblyVersion>
 105       </AssemblyInfo>
 106       <Parameters>
 107         <Parameter Name="message" Type="System.String" />
 108         <Parameter Name="optionName" Type="System.String" />
 109       </Parameters>
 110       <Docs>
 111         <param name="message">
 112           A <see cref="T:System.String" /> that describes the error.
 113         </param>
 114         <param name="optionName">
 115           A <see cref="T:System.String" /> that contains the name of the
 116                       option that caused the exception.
 117         </param>
 118         <summary>
 119           Creates and initializes a new instance of the
 120           <see cref="T:Mono.Options.OptionException" /> class.
 121         </summary>
 122         <remarks>
 123           This constructor initializes the
 124           <see cref="P:System.Exception.Message" /> property of the new
 125           instance using <paramref name="message" />, and the
 126           <see cref="P:Mono.Options.OptionException.OptionName" />
 127           property of the new instance using <paramref name="optionName" />.
 128         </remarks>
 129       </Docs>
 130     </Member>
 131     <Member MemberName=".ctor">
 132       <MemberSignature Language="C#" Value="public OptionException (string message, string optionName, Exception innerException);" />
 133       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, string optionName, class System.Exception innerException) cil managed" />
 134       <MemberType>Constructor</MemberType>
 135       <AssemblyInfo>
 136         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 137         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 138         <AssemblyVersion>0.2.2.0</AssemblyVersion>
 139       </AssemblyInfo>
 140       <Parameters>
 141         <Parameter Name="message" Type="System.String" />
 142         <Parameter Name="optionName" Type="System.String" />
 143         <Parameter Name="innerException" Type="System.Exception" />
 144       </Parameters>
 145       <Docs>
 146         <param name="message">
 147           A <see cref="T:System.String" /> that describes the error.
 148         </param>
 149         <param name="optionName">
 150           A <see cref="T:System.String" /> that contains the name of the
 151           option that caused the exception.
 152         </param>
 153         <param name="innerException">
 154           An instance of <see cref="T:System.Exception" /> that is the cause
 155           of the current exception.  If <paramref name="innerException" /> is
 156           non-<see langword="null" />, then the current Exception was raised
 157           in a catch block handling <paramref name="innerException" />.
 158         </param>
 159         <summary>
 160           Creates and initializes a new instance of the
 161           <see cref="T:Mono.Options.OptionException" /> class.
 162         </summary>
 163         <remarks>
 164           This constructor initializes the
 165           <see cref="P:System.Exception.Message" /> property of the new
 166           instance using <paramref name="message" />, the
 167           <see cref="P:System.Exception.InnerException" /> property of the new
 168           instance using <paramref name="innerException" />, and the
 169           <see cref="P:Mono.Options.OptionException.OptionName" />
 170           property of the new instance using <paramref name="optionName" />.
 171         </remarks>
 172       </Docs>
 173     </Member>
 174     <Member MemberName="GetObjectData">
 175       <MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
 176       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
 177       <MemberType>Method</MemberType>
 178       <AssemblyInfo>
 179         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 180         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 181         <AssemblyVersion>0.2.2.0</AssemblyVersion>
 182       </AssemblyInfo>
 183       <ReturnValue>
 184         <ReturnType>System.Void</ReturnType>
 185       </ReturnValue>
 186       <Parameters>
 187         <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
 188         <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
 189       </Parameters>
 190       <Docs>
 191         <param name="info">
 192           The <see cref="T:System.Runtime.Serialization.SerializationInfo" />
 193           that holds the serialized object data about the exception being
 194           thrown.
 195         </param>
 196         <param name="context">
 197           The <see cref="T:System.Runtime.Serialization.StreamingContext" />
 198           that contains contextual information about the source or
 199           destination.
 200         </param>
 201         <summary>
 202           Adds information about the exception to the provided
 203           <see cref="T:System.Runtime.Serialization.SerializationInfo" />
 204           instance.
 205         </summary>
 206         <remarks>
 207           Adds information about this exception instance to the provided
 208           <see cref="T:System.Runtime.Serialization.SerializationInfo" />,
 209           so that a new cloned instance may be properly reconstituted later.
 210         </remarks>
 211         <altmember cref="C:Mono.Options.OptionException(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
 212       </Docs>
 213     </Member>
 214     <Member MemberName="OptionName">
 215       <MemberSignature Language="C#" Value="public string OptionName { get; }" />
 216       <MemberSignature Language="ILAsm" Value=".property instance string OptionName" />
 217       <MemberType>Property</MemberType>
 218       <AssemblyInfo>
 219         <AssemblyVersion>0.2.0.0</AssemblyVersion>
 220         <AssemblyVersion>0.2.1.0</AssemblyVersion>
 221         <AssemblyVersion>0.2.2.0</AssemblyVersion>
 222       </AssemblyInfo>
 223       <ReturnValue>
 224         <ReturnType>System.String</ReturnType>
 225       </ReturnValue>
 226       <Docs>
 227         <summary>
 228           A <see cref="T:System.String" /> containing the option name that
 229           caused the exception.
 230         </summary>
 231         <value>
 232           A <see cref="T:System.String" /> containing the option name that
 233           caused the exception.
 234         </value>
 235         <remarks>
 236         </remarks>
 237       </Docs>
 238     </Member>
 239   </Members>
 240 </Type>