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

   1 <Type Name="OptionValueType" FullName="Mono.Options.OptionValueType">
   2   <TypeSignature Language="C#" Value="public enum OptionValueType" />
   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.Enum</BaseTypeName>
  10   </Base>
  11   <Docs>
  12     <summary>
  13       Specifies whether or not a <see cref="T:Mono.Options.Option" />
  14       takes a value, and if it does, whether it's optional or required.
  15                 </summary>
  16     <remarks>
  17     </remarks>
  18     <altmember cref="P:Mono.Options.Option.OptionValueType" />
  19   </Docs>
  20   <Members>
  21     <Member MemberName="None">
  22       <MemberSignature Language="C#" Value="None" />
  23       <MemberType>Field</MemberType>
  24       <AssemblyInfo>
  25         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  26         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  27       </AssemblyInfo>
  28       <ReturnValue>
  29         <ReturnType>Mono.Options.OptionValueType</ReturnType>
  30       </ReturnValue>
  31       <Docs>
  32         <summary>
  33           <para>No value is taken.</para>
  34           <para>If an option takes no value, then the callback function will
  35           receive <see langword="null" /> if the value is
  36           <see langword="false" /> (e.g. <c>-optionName-</c> was used) and
  37           non-<see langword="null" /> if the value is <see langword="true" />
  38           (e.g. <c>-optionName</c>, <c>-optionName+</c>).</para>
  39         </summary>
  40       </Docs>
  41     </Member>
  42     <Member MemberName="Optional">
  43       <MemberSignature Language="C#" Value="Optional" />
  44       <MemberType>Field</MemberType>
  45       <AssemblyInfo>
  46         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  47         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  48       </AssemblyInfo>
  49       <ReturnValue>
  50         <ReturnType>Mono.Options.OptionValueType</ReturnType>
  51       </ReturnValue>
  52       <Docs>
  53         <summary>
  54           <para>A value is optional.</para>
  55           <para>This is specified by providing <c>:</c> after the option name
  56             within <see cref="P:Mono.Options.Option.Prototype" />.</para>
  57           <para>If a value is optional, the callback function will receive
  58             <see langword="null" /> value if no value is provided, and will
  59             otherwise receive a non-<see langword="null" /> value.</para>
  60           <para>Options with optional values are not "greedy" -- the value
  61             must be part of the current argument, e.g. <c>-opt:foo</c> will
  62             pass <c>"foo"</c> as the value to <c>-opt</c>, but <c>-opt foo</c>
  63             will pass <see langword="null" /> as the value to <c>-opt</c>.
  64             </para>
  65         </summary>
  66       </Docs>
  67     </Member>
  68     <Member MemberName="Required">
  69       <MemberSignature Language="C#" Value="Required" />
  70       <MemberType>Field</MemberType>
  71       <AssemblyInfo>
  72         <AssemblyVersion>0.2.0.0</AssemblyVersion>
  73         <AssemblyVersion>0.2.1.0</AssemblyVersion>
  74       </AssemblyInfo>
  75       <ReturnValue>
  76         <ReturnType>Mono.Options.OptionValueType</ReturnType>
  77       </ReturnValue>
  78       <Docs>
  79         <summary>
  80           <para>A value is required.</para>
  81           <para>This is specified by providing <c>=</c> after the option name
  82             within <see cref="P:Mono.Options.Option.Prototype" />.</para>
  83           <para>Options with required values are "greedy" -- if the current
  84             argument does not contain a value, the next argument will be used
  85             as the value, e.g. both <c>-opt:foo</c> and <c>-opt foo</c> will
  86             pass <c>"foo"</c> as the value to <c>-opt</c>.</para>
  87         </summary>
  88       </Docs>
  89     </Member>
  90   </Members>
  91 </Type>