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