Microsoft.Extensions.Options.ConfigurationExtensions.xml 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Options.ConfigurationExtensions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1">
  8. <summary>
  9. Creates <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>s so that <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1"/> gets
  10. notified when <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> changes.
  11. </summary>
  12. <typeparam name="TOptions"></typeparam>
  13. </member>
  14. <member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
  15. <summary>
  16. Constructor taking the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to watch.
  17. </summary>
  18. <param name="config">The configuration instance.</param>
  19. </member>
  20. <member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
  21. <summary>
  22. Constructor taking the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to watch.
  23. </summary>
  24. <param name="name">The name of the options instance being watched.</param>
  25. <param name="config">The configuration instance.</param>
  26. </member>
  27. <member name="P:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.Name">
  28. <summary>
  29. The name of the option instance being changed.
  30. </summary>
  31. </member>
  32. <member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.GetChangeToken">
  33. <summary>
  34. Returns the reloadToken from the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  35. </summary>
  36. <returns></returns>
  37. </member>
  38. <member name="T:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1">
  39. <summary>
  40. Configures an option instance by using <see cref="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)"/> against an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  41. </summary>
  42. <typeparam name="TOptions">The type of options to bind.</typeparam>
  43. </member>
  44. <member name="M:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
  45. <summary>
  46. Constructor that takes the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
  47. </summary>
  48. <param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
  49. </member>
  50. <member name="T:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1">
  51. <summary>
  52. Configures an option instance by using <see cref="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)"/> against an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  53. </summary>
  54. <typeparam name="TOptions">The type of options to bind.</typeparam>
  55. </member>
  56. <member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
  57. <summary>
  58. Constructor that takes the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
  59. </summary>
  60. <param name="name">The name of the options instance.</param>
  61. <param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
  62. </member>
  63. <member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  64. <summary>
  65. Constructor that takes the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance to bind against.
  66. </summary>
  67. <param name="name">The name of the options instance.</param>
  68. <param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> instance.</param>
  69. <param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
  70. </member>
  71. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions">
  72. <summary>
  73. Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.
  74. </summary>
  75. </member>
  76. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration)">
  77. <summary>
  78. Registers a configuration instance which <typeparamref name="TOptions"/> will bind against.
  79. </summary>
  80. <typeparam name="TOptions">The options type to be configured.</typeparam>
  81. <param name="optionsBuilder">The options builder to add the services to.</param>
  82. <param name="config">The configuration being bound.</param>
  83. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
  84. </member>
  85. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  86. <summary>
  87. Registers a configuration instance which <typeparamref name="TOptions"/> will bind against.
  88. </summary>
  89. <typeparam name="TOptions">The options type to be configured.</typeparam>
  90. <param name="optionsBuilder">The options builder to add the services to.</param>
  91. <param name="config">The configuration being bound.</param>
  92. <param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
  93. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
  94. </member>
  95. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.BindConfiguration``1(Microsoft.Extensions.Options.OptionsBuilder{``0},System.String,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  96. <summary>
  97. Registers the dependency injection container to bind <typeparamref name="TOptions"/> against
  98. the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> obtained from the DI service provider.
  99. </summary>
  100. <typeparam name="TOptions">The options type to be configured.</typeparam>
  101. <param name="optionsBuilder">The options builder to add the services to.</param>
  102. <param name="configSectionPath">The name of the configuration section to bind from.</param>
  103. <param name="configureBinder">Optional. Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
  104. <returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
  105. <exception cref="T:System.ArgumentNullException">
  106. <paramref name="optionsBuilder"/> or <paramref name="configSectionPath" /> is <see langword="null"/>.
  107. </exception>
  108. <seealso cref="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})"/>
  109. </member>
  110. <member name="T:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions">
  111. <summary>
  112. Extension methods for adding configuration related options services to the DI container.
  113. </summary>
  114. </member>
  115. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
  116. <summary>
  117. Registers a configuration instance which TOptions will bind against.
  118. </summary>
  119. <typeparam name="TOptions">The type of options being configured.</typeparam>
  120. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  121. <param name="config">The configuration being bound.</param>
  122. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  123. </member>
  124. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
  125. <summary>
  126. Registers a configuration instance which TOptions will bind against.
  127. </summary>
  128. <typeparam name="TOptions">The type of options being configured.</typeparam>
  129. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  130. <param name="name">The name of the options instance.</param>
  131. <param name="config">The configuration being bound.</param>
  132. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  133. </member>
  134. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  135. <summary>
  136. Registers a configuration instance which TOptions will bind against.
  137. </summary>
  138. <typeparam name="TOptions">The type of options being configured.</typeparam>
  139. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  140. <param name="config">The configuration being bound.</param>
  141. <param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
  142. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  143. </member>
  144. <member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  145. <summary>
  146. Registers a configuration instance which TOptions will bind against.
  147. </summary>
  148. <typeparam name="TOptions">The type of options being configured.</typeparam>
  149. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
  150. <param name="name">The name of the options instance.</param>
  151. <param name="config">The configuration being bound.</param>
  152. <param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
  153. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  154. </member>
  155. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  156. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  157. <param name="argument">The reference type argument to validate as non-null.</param>
  158. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  159. </member>
  160. <member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
  161. <summary>
  162. Indicates that the specified method requires the ability to generate new code at runtime,
  163. for example through <see cref="N:System.Reflection"/>.
  164. </summary>
  165. <remarks>
  166. This allows tools to understand which methods are unsafe to call when compiling ahead of time.
  167. </remarks>
  168. </member>
  169. <member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
  170. <summary>
  171. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
  172. with the specified message.
  173. </summary>
  174. <param name="message">
  175. A message that contains information about the usage of dynamic code.
  176. </param>
  177. </member>
  178. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
  179. <summary>
  180. Gets a message that contains information about the usage of dynamic code.
  181. </summary>
  182. </member>
  183. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
  184. <summary>
  185. Gets or sets an optional URL that contains more information about the method,
  186. why it requires dynamic code, and what options a consumer has to deal with it.
  187. </summary>
  188. </member>
  189. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  190. <summary>
  191. Attribute used to indicate a source generator should create a function for marshalling
  192. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  193. </summary>
  194. <remarks>
  195. This attribute is meaningless if the source generator associated with it is not enabled.
  196. The current built-in source generator only supports C# and only supplies an implementation when
  197. applied to static, partial, non-generic methods.
  198. </remarks>
  199. </member>
  200. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  201. <summary>
  202. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  203. </summary>
  204. <param name="libraryName">Name of the library containing the import.</param>
  205. </member>
  206. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  207. <summary>
  208. Gets the name of the library containing the import.
  209. </summary>
  210. </member>
  211. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  212. <summary>
  213. Gets or sets the name of the entry point to be called.
  214. </summary>
  215. </member>
  216. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  217. <summary>
  218. Gets or sets how to marshal string arguments to the method.
  219. </summary>
  220. <remarks>
  221. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  222. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  223. </remarks>
  224. </member>
  225. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  226. <summary>
  227. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  228. </summary>
  229. <remarks>
  230. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  231. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  232. </remarks>
  233. </member>
  234. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  235. <summary>
  236. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  237. on other platforms) before returning from the attributed method.
  238. </summary>
  239. </member>
  240. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  241. <summary>
  242. Specifies how strings should be marshalled for generated p/invokes
  243. </summary>
  244. </member>
  245. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  246. <summary>
  247. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  248. </summary>
  249. </member>
  250. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  251. <summary>
  252. Use the platform-provided UTF-8 marshaller.
  253. </summary>
  254. </member>
  255. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  256. <summary>
  257. Use the platform-provided UTF-16 marshaller.
  258. </summary>
  259. </member>
  260. </members>
  261. </doc>