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

   1 <Type Name="ResponseFileSource" FullName="Mono.Options.ResponseFileSource">
   2   <TypeSignature Language="C#" Value="public class ResponseFileSource : Mono.Options.ArgumentSource" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ResponseFileSource extends Mono.Options.ArgumentSource" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Options</AssemblyName>
   6     <AssemblyVersion>0.2.2.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>Mono.Options.ArgumentSource</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <summary>
  14       Inserts the contents of a file during argument processing.
  15     </summary>
  16     <remarks>
  17       <para>
  18         <c>ResponseFileSource</c> looks for arguments which start with
  19         <c>@</c>, assumes that what follows the <c>@</c> is a valid filename,
  20         and reads the contents of the filename as the replacement text.
  21       </para>
  22     </remarks>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public ResponseFileSource ();" />
  27       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  28       <MemberType>Constructor</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>0.2.2.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <Parameters />
  33       <Docs>
  34         <summary>
  35           Constructs and initializes a
  36           <see cref="T:Mono.Options.ResponseFileSource" /> instance.
  37         </summary>
  38         <remarks>
  39         </remarks>
  40       </Docs>
  41     </Member>
  42     <Member MemberName="Description">
  43       <MemberSignature Language="C#" Value="public override string Description { get; }" />
  44       <MemberSignature Language="ILAsm" Value=".property instance string Description" />
  45       <MemberType>Property</MemberType>
  46       <AssemblyInfo>
  47         <AssemblyVersion>0.2.2.0</AssemblyVersion>
  48       </AssemblyInfo>
  49       <ReturnValue>
  50         <ReturnType>System.String</ReturnType>
  51       </ReturnValue>
  52       <Docs>
  53         <summary>
  54           The description to provide for the argument source within
  55           <see cref="M:Mono.Options.OptionSet.WriteOptionDescriptions(System.IO.TextWriter)" />.
  56         </summary>
  57         <value>
  58           <c>"Read response file for more options."</c>.
  59         </value>
  60         <remarks>
  61         </remarks>
  62       </Docs>
  63     </Member>
  64     <Member MemberName="GetArguments">
  65       <MemberSignature Language="C#" Value="public override bool GetArguments (string value, out System.Collections.Generic.IEnumerable&lt;string&gt; replacement);" />
  66       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool GetArguments(string value, class System.Collections.Generic.IEnumerable`1&lt;string&gt; replacement) cil managed" />
  67       <MemberType>Method</MemberType>
  68       <AssemblyInfo>
  69         <AssemblyVersion>0.2.2.0</AssemblyVersion>
  70       </AssemblyInfo>
  71       <ReturnValue>
  72         <ReturnType>System.Boolean</ReturnType>
  73       </ReturnValue>
  74       <Parameters>
  75         <Parameter Name="value" Type="System.String" />
  76         <Parameter Name="replacement" Type="System.Collections.Generic.IEnumerable&lt;System.String&gt;&amp;" RefType="out" />
  77       </Parameters>
  78       <Docs>
  79         <param name="value">
  80           A <see cref="T:System.String" /> containing the argument to replace
  81           with additional arguments.
  82         </param>
  83         <param name="replacement">
  84           A <see cref="T:System.Collections.Generic.IEnumerable{System.String}" />
  85           which will refer to teh replacement arguments if this method returns
  86           <see langword="true" />; otherwise, this value should be ignored by
  87           callers.
  88         </param>
  89         <summary>
  90           Replace the argument <paramref name="value" /> with the contents of
  91           the specified file.
  92         </summary>
  93         <returns>
  94           If <paramref name="value" /> starts with <c>@</c>, then
  95           <paramref name="replacement" /> will contain the parsed contents of
  96           the filename resulting from <c><paramref name="value" />.Substring(1)</c>
  97           and <see langword="true" /> is returned; otherwise,
  98           <see langword="false" /> is returned.
  99         </returns>
 100         <remarks>
 101         </remarks>
 102         <exception cref="T:System.IO.IOException">
 103           <paramref name="value" /> starts with <c>@</c> and
 104           <c><paramref name="value" />.Substring(1)</c> doees not exist.
 105         </exception>
 106         <altmember cref="M:Mono.Options.ArgumentSource.GetArgumentsFromFile(System.String)" />
 107       </Docs>
 108     </Member>
 109     <Member MemberName="GetNames">
 110       <MemberSignature Language="C#" Value="public override string[] GetNames ();" />
 111       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string[] GetNames() cil managed" />
 112       <MemberType>Method</MemberType>
 113       <AssemblyInfo>
 114         <AssemblyVersion>0.2.2.0</AssemblyVersion>
 115       </AssemblyInfo>
 116       <ReturnValue>
 117         <ReturnType>System.String[]</ReturnType>
 118       </ReturnValue>
 119       <Parameters />
 120       <Docs>
 121         <summary>
 122           The names to provide for the argument source within
 123           <see cref="M:Mono.Options.OptionSet.WriteOptionDescriptions(System.IO.TextWriter)" />.
 124         </summary>
 125         <returns>
 126           A <see cref="T:System.String" /> array containing
 127           an element with the value <c>"@file"</c>.
 128         </returns>
 129         <remarks>
 130         </remarks>
 131       </Docs>
 132     </Member>
 133   </Members>
 134 </Type>