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