review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.Extensions.Configuration.FileExtensions</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions">\r
   8             <summary>\r
   9             Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)">\r
  13             <summary>\r
  14             Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.\r
  15             </summary>\r
  16             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
  17             <param name="fileProvider">The default file provider instance.</param>\r
  18             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  19         </member>\r
  20         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
  21             <summary>\r
  22             Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.\r
  23             </summary>\r
  24             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
  25             <returns>The default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/>.</returns>\r
  26         </member>\r
  27         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">\r
  28             <summary>\r
  29             Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.\r
  30             </summary>\r
  31             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
  32             <param name="basePath">The absolute path of file-based providers.</param>\r
  33             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  34         </member>\r
  35         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})">\r
  36             <summary>\r
  37             Sets a default action to be invoked for file-based providers when an error occurs.\r
  38             </summary>\r
  39             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>\r
  40             <param name="handler">The Action to be invoked on a file load exception.</param>\r
  41             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  42         </member>\r
  43         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
  44             <summary>\r
  45             Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.\r
  46             </summary>\r
  47             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
  48             <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>\r
  49         </member>\r
  50         <member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider">\r
  51             <summary>\r
  52             Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.\r
  53             </summary>\r
  54         </member>\r
  55         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)">\r
  56             <summary>\r
  57             Initializes a new instance with the specified source.\r
  58             </summary>\r
  59             <param name="source">The source settings.</param>\r
  60         </member>\r
  61         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source">\r
  62             <summary>\r
  63             The source settings for this provider.\r
  64             </summary>\r
  65         </member>\r
  66         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.ToString">\r
  67             <summary>\r
  68             Generates a string representing this provider name and relevant details.\r
  69             </summary>\r
  70             <returns> The configuration name. </returns>\r
  71         </member>\r
  72         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load">\r
  73             <summary>\r
  74             Loads the contents of the file at <see cref="T:System.IO.Path"/>.\r
  75             </summary>\r
  76             <exception cref="T:System.IO.DirectoryNotFoundException">If Optional is <c>false</c> on the source and part of a file or\r
  77             or directory cannot be found at the specified Path.</exception>\r
  78             <exception cref="T:System.IO.FileNotFoundException">If Optional is <c>false</c> on the source and a\r
  79             file does not exist at specified Path.</exception>\r
  80             <exception cref="T:System.IO.InvalidDataException">Wrapping any exception thrown by the concrete implementation of the\r
  81             <see cref="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load"/> method. Use the source <see cref="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException"/> callback\r
  82             if you need more control over the exception.</exception>\r
  83         </member>\r
  84         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">\r
  85             <summary>\r
  86             Loads this provider's data from a stream.\r
  87             </summary>\r
  88             <param name="stream">The stream to read.</param>\r
  89         </member>\r
  90         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose">\r
  91             <inheritdoc />\r
  92         </member>\r
  93         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Dispose(System.Boolean)">\r
  94             <summary>\r
  95             Dispose the provider.\r
  96             </summary>\r
  97             <param name="disposing"><c>true</c> if invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>\r
  98         </member>\r
  99         <member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">\r
 100             <summary>\r
 101             Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.\r
 102             </summary>\r
 103         </member>\r
 104         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">\r
 105             <summary>\r
 106             Used to access the contents of the file.\r
 107             </summary>\r
 108         </member>\r
 109         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">\r
 110             <summary>\r
 111             The path to the file.\r
 112             </summary>\r
 113         </member>\r
 114         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">\r
 115             <summary>\r
 116             Determines if loading the file is optional.\r
 117             </summary>\r
 118         </member>\r
 119         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">\r
 120             <summary>\r
 121             Determines whether the source will be loaded if the underlying file changes.\r
 122             </summary>\r
 123         </member>\r
 124         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">\r
 125             <summary>\r
 126             Number of milliseconds that reload will wait before calling Load.  This helps\r
 127             avoid triggering reload before a file is completely written. Default is 250.\r
 128             </summary>\r
 129         </member>\r
 130         <member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">\r
 131             <summary>\r
 132             Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.\r
 133             </summary>\r
 134         </member>\r
 135         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
 136             <summary>\r
 137             Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.\r
 138             </summary>\r
 139             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
 140             <returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>\r
 141         </member>\r
 142         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">\r
 143             <summary>\r
 144             Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.\r
 145             </summary>\r
 146             <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>\r
 147         </member>\r
 148         <member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">\r
 149             <summary>\r
 150             If no file provider has been set, for absolute Path, this will creates a physical file provider\r
 151             for the nearest existing directory.\r
 152             </summary>\r
 153         </member>\r
 154         <member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">\r
 155             <summary>\r
 156             Contains information about a file load exception.\r
 157             </summary>\r
 158         </member>\r
 159         <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">\r
 160             <summary>\r
 161             The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.\r
 162             </summary>\r
 163         </member>\r
 164         <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">\r
 165             <summary>\r
 166             The exception that occurred in Load.\r
 167             </summary>\r
 168         </member>\r
 169         <member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">\r
 170             <summary>\r
 171             If true, the exception will not be rethrown.\r
 172             </summary>\r
 173         </member>\r
 174         <member name="P:System.SR.Error_ExpectedPhysicalPath">\r
 175             <summary>The expected physical path was '{0}'.</summary>\r
 176         </member>\r
 177         <member name="P:System.SR.Error_FileNotFound">\r
 178             <summary>The configuration file '{0}' was not found and is not optional.</summary>\r
 179         </member>\r
 180         <member name="P:System.SR.Error_FailedToLoad">\r
 181             <summary>Failed to load configuration from file '{0}'.</summary>\r
 182         </member>\r
 183     </members>\r
 184 </doc>\r