-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
FileConfigurationSource.xml
299 lines (299 loc) · 18.2 KB
/
FileConfigurationSource.xml
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<Type Name="FileConfigurationSource" FullName="Microsoft.Extensions.Configuration.FileConfigurationSource">
<TypeSignature Language="C#" Value="public abstract class FileConfigurationSource : Microsoft.Extensions.Configuration.IConfigurationSource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit FileConfigurationSource extends System.Object implements class Microsoft.Extensions.Configuration.IConfigurationSource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.FileConfigurationSource" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class FileConfigurationSource
Implements IConfigurationSource" />
<TypeSignature Language="F#" Value="type FileConfigurationSource = class
 interface IConfigurationSource" />
<TypeSignature Language="C++ CLI" Value="public ref class FileConfigurationSource abstract : Microsoft::Extensions::Configuration::IConfigurationSource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Extensions.Configuration.IConfigurationSource</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides the base class for file-based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FileConfigurationSource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.FileConfigurationSource.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 FileConfigurationSource();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationSource" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Build">
<MemberSignature Language="C#" Value="public abstract Microsoft.Extensions.Configuration.IConfigurationProvider Build (Microsoft.Extensions.Configuration.IConfigurationBuilder builder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.Configuration.IConfigurationProvider Build(class Microsoft.Extensions.Configuration.IConfigurationBuilder builder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Build (builder As IConfigurationBuilder) As IConfigurationProvider" />
<MemberSignature Language="F#" Value="abstract member Build : Microsoft.Extensions.Configuration.IConfigurationBuilder -> Microsoft.Extensions.Configuration.IConfigurationProvider" Usage="fileConfigurationSource.Build builder" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract Microsoft::Extensions::Configuration::IConfigurationProvider ^ Build(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Configuration.IConfigurationProvider</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.Extensions.Configuration.IConfigurationBuilder" />
</Parameters>
<Docs>
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param>
<summary>
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> for this source.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureDefaults">
<MemberSignature Language="C#" Value="public void EnsureDefaults (Microsoft.Extensions.Configuration.IConfigurationBuilder builder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnsureDefaults(class Microsoft.Extensions.Configuration.IConfigurationBuilder builder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Sub EnsureDefaults (builder As IConfigurationBuilder)" />
<MemberSignature Language="F#" Value="member this.EnsureDefaults : Microsoft.Extensions.Configuration.IConfigurationBuilder -> unit" Usage="fileConfigurationSource.EnsureDefaults builder" />
<MemberSignature Language="C++ CLI" Value="public:
 void EnsureDefaults(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.Extensions.Configuration.IConfigurationBuilder" />
</Parameters>
<Docs>
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</param>
<summary>
Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FileProvider">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.FileProviders.IFileProvider? FileProvider { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Extensions.FileProviders.IFileProvider FileProvider" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider" />
<MemberSignature Language="VB.NET" Value="Public Property FileProvider As IFileProvider" />
<MemberSignature Language="F#" Value="member this.FileProvider : Microsoft.Extensions.FileProviders.IFileProvider with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::FileProviders::IFileProvider ^ FileProvider { Microsoft::Extensions::FileProviders::IFileProvider ^ get(); void set(Microsoft::Extensions::FileProviders::IFileProvider ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.FileProviders.IFileProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the provider used to access the contents of the file.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnLoadException">
<MemberSignature Language="C#" Value="public Action<Microsoft.Extensions.Configuration.FileLoadExceptionContext>? OnLoadException { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class Microsoft.Extensions.Configuration.FileLoadExceptionContext> OnLoadException" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException" />
<MemberSignature Language="VB.NET" Value="Public Property OnLoadException As Action(Of FileLoadExceptionContext)" />
<MemberSignature Language="F#" Value="member this.OnLoadException : Action<Microsoft.Extensions.Configuration.FileLoadExceptionContext> with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException" />
<MemberSignature Language="C++ CLI" Value="public:
 property Action<Microsoft::Extensions::Configuration::FileLoadExceptionContext ^> ^ OnLoadException { Action<Microsoft::Extensions::Configuration::FileLoadExceptionContext ^> ^ get(); void set(Action<Microsoft::Extensions::Configuration::FileLoadExceptionContext ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Action<Microsoft.Extensions.Configuration.FileLoadExceptionContext></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the action that's called if an uncaught exception occurs in FileConfigurationProvider.Load.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Optional">
<MemberSignature Language="C#" Value="public bool Optional { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Optional" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional" />
<MemberSignature Language="VB.NET" Value="Public Property Optional As Boolean" />
<MemberSignature Language="F#" Value="member this.Optional : bool with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.Optional" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Optional { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates whether loading the file is optional.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string? Path { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path" />
<MemberSignature Language="VB.NET" Value="Public Property Path As String" />
<MemberSignature Language="F#" Value="member this.Path : string with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.Path" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Path { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the path to the file.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReloadDelay">
<MemberSignature Language="C#" Value="public int ReloadDelay { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ReloadDelay" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay" />
<MemberSignature Language="VB.NET" Value="Public Property ReloadDelay As Integer" />
<MemberSignature Language="F#" Value="member this.ReloadDelay : int with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay" />
<MemberSignature Language="C++ CLI" Value="public:
 property int ReloadDelay { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of milliseconds that reload will wait before calling Load.
</summary>
<value>
The number of milliseconds that reload waits before calling Load. The default is 250.
</value>
<remarks>
This delay helps avoid triggering reload before a file is completely written.
</remarks>
</Docs>
</Member>
<Member MemberName="ReloadOnChange">
<MemberSignature Language="C#" Value="public bool ReloadOnChange { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ReloadOnChange" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange" />
<MemberSignature Language="VB.NET" Value="Public Property ReloadOnChange As Boolean" />
<MemberSignature Language="F#" Value="member this.ReloadOnChange : bool with get, set" Usage="Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool ReloadOnChange { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates whether the source will be loaded if the underlying file changes.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResolveFileProvider">
<MemberSignature Language="C#" Value="public void ResolveFileProvider ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResolveFileProvider() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider" />
<MemberSignature Language="VB.NET" Value="Public Sub ResolveFileProvider ()" />
<MemberSignature Language="F#" Value="member this.ResolveFileProvider : unit -> unit" Usage="fileConfigurationSource.ResolveFileProvider " />
<MemberSignature Language="C++ CLI" Value="public:
 void ResolveFileProvider();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Configuration.FileExtensions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a physical file provider for the nearest existing directory if no file provider has been set, for absolute Path.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>