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