Microsoft.Extensions.Configuration.Binder.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Binder</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.BinderOptions">
  8. <summary>
  9. Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
  13. <summary>
  14. When false (the default), the binder will only attempt to set public properties.
  15. If true, the binder will attempt to set all non read-only properties.
  16. </summary>
  17. </member>
  18. <member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
  19. <summary>
  20. When false (the default), no exceptions are thrown when a configuration key is found for which the
  21. provided model object does not have an appropriate property which matches the key's name.
  22. When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
  23. of the missing properties.
  24. </summary>
  25. </member>
  26. <member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
  27. <summary>
  28. Static helper class that allows binding strongly typed objects to configuration values.
  29. </summary>
  30. </member>
  31. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
  32. <summary>
  33. Attempts to bind the configuration instance to a new instance of type T.
  34. If this configuration section has a value, that will be used.
  35. Otherwise binding by matching property names against configuration keys recursively.
  36. </summary>
  37. <typeparam name="T">The type of the new instance to bind.</typeparam>
  38. <param name="configuration">The configuration instance to bind.</param>
  39. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  40. </member>
  41. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  42. <summary>
  43. Attempts to bind the configuration instance to a new instance of type T.
  44. If this configuration section has a value, that will be used.
  45. Otherwise binding by matching property names against configuration keys recursively.
  46. </summary>
  47. <typeparam name="T">The type of the new instance to bind.</typeparam>
  48. <param name="configuration">The configuration instance to bind.</param>
  49. <param name="configureOptions">Configures the binder options.</param>
  50. <returns>The new instance of T if successful, default(T) otherwise.</returns>
  51. </member>
  52. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
  53. <summary>
  54. Attempts to bind the configuration instance to a new instance of type T.
  55. If this configuration section has a value, that will be used.
  56. Otherwise binding by matching property names against configuration keys recursively.
  57. </summary>
  58. <param name="configuration">The configuration instance to bind.</param>
  59. <param name="type">The type of the new instance to bind.</param>
  60. <returns>The new instance if successful, null otherwise.</returns>
  61. </member>
  62. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  63. <summary>
  64. Attempts to bind the configuration instance to a new instance of type T.
  65. If this configuration section has a value, that will be used.
  66. Otherwise binding by matching property names against configuration keys recursively.
  67. </summary>
  68. <param name="configuration">The configuration instance to bind.</param>
  69. <param name="type">The type of the new instance to bind.</param>
  70. <param name="configureOptions">Configures the binder options.</param>
  71. <returns>The new instance if successful, null otherwise.</returns>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
  74. <summary>
  75. Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
  76. </summary>
  77. <param name="configuration">The configuration instance to bind.</param>
  78. <param name="key">The key of the configuration section to bind.</param>
  79. <param name="instance">The object to bind.</param>
  80. </member>
  81. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
  82. <summary>
  83. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  84. </summary>
  85. <param name="configuration">The configuration instance to bind.</param>
  86. <param name="instance">The object to bind.</param>
  87. </member>
  88. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
  89. <summary>
  90. Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
  91. </summary>
  92. <param name="configuration">The configuration instance to bind.</param>
  93. <param name="instance">The object to bind.</param>
  94. <param name="configureOptions">Configures the binder options.</param>
  95. </member>
  96. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  97. <summary>
  98. Extracts the value with the specified key and converts it to type T.
  99. </summary>
  100. <typeparam name="T">The type to convert the value to.</typeparam>
  101. <param name="configuration">The configuration.</param>
  102. <param name="key">The key of the configuration section's value to convert.</param>
  103. <returns>The converted value.</returns>
  104. </member>
  105. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
  106. <summary>
  107. Extracts the value with the specified key and converts it to type T.
  108. </summary>
  109. <typeparam name="T">The type to convert the value to.</typeparam>
  110. <param name="configuration">The configuration.</param>
  111. <param name="key">The key of the configuration section's value to convert.</param>
  112. <param name="defaultValue">The default value to use if no value is found.</param>
  113. <returns>The converted value.</returns>
  114. </member>
  115. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
  116. <summary>
  117. Extracts the value with the specified key and converts it to the specified type.
  118. </summary>
  119. <param name="configuration">The configuration.</param>
  120. <param name="type">The type to convert the value to.</param>
  121. <param name="key">The key of the configuration section's value to convert.</param>
  122. <returns>The converted value.</returns>
  123. </member>
  124. <member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
  125. <summary>
  126. Extracts the value with the specified key and converts it to the specified type.
  127. </summary>
  128. <param name="configuration">The configuration.</param>
  129. <param name="type">The type to convert the value to.</param>
  130. <param name="key">The key of the configuration section's value to convert.</param>
  131. <param name="defaultValue">The default value to use if no value is found.</param>
  132. <returns>The converted value.</returns>
  133. </member>
  134. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  135. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  136. <param name="argument">The reference type argument to validate as non-null.</param>
  137. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  138. </member>
  139. <member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
  140. <summary>
  141. Indicates that the specified method requires the ability to generate new code at runtime,
  142. for example through <see cref="N:System.Reflection"/>.
  143. </summary>
  144. <remarks>
  145. This allows tools to understand which methods are unsafe to call when compiling ahead of time.
  146. </remarks>
  147. </member>
  148. <member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
  149. <summary>
  150. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
  151. with the specified message.
  152. </summary>
  153. <param name="message">
  154. A message that contains information about the usage of dynamic code.
  155. </param>
  156. </member>
  157. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
  158. <summary>
  159. Gets a message that contains information about the usage of dynamic code.
  160. </summary>
  161. </member>
  162. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
  163. <summary>
  164. Gets or sets an optional URL that contains more information about the method,
  165. why it requires dynamic code, and what options a consumer has to deal with it.
  166. </summary>
  167. </member>
  168. <member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
  169. <summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
  170. </member>
  171. <member name="P:System.SR.Error_CannotBindToConstructorParameter">
  172. <summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
  173. </member>
  174. <member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
  175. <summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
  176. </member>
  177. <member name="P:System.SR.Error_FailedBinding">
  178. <summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
  179. </member>
  180. <member name="P:System.SR.Error_FailedToActivate">
  181. <summary>Failed to create instance of type '{0}'.</summary>
  182. </member>
  183. <member name="P:System.SR.Error_MissingConfig">
  184. <summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
  185. </member>
  186. <member name="P:System.SR.Error_MissingPublicInstanceConstructor">
  187. <summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
  188. </member>
  189. <member name="P:System.SR.Error_MultipleParameterizedConstructors">
  190. <summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
  191. </member>
  192. <member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
  193. <summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
  194. </member>
  195. <member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
  196. <summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
  197. </member>
  198. <member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
  199. <summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
  200. </member>
  201. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  202. <summary>
  203. Attribute used to indicate a source generator should create a function for marshalling
  204. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  205. </summary>
  206. <remarks>
  207. This attribute is meaningless if the source generator associated with it is not enabled.
  208. The current built-in source generator only supports C# and only supplies an implementation when
  209. applied to static, partial, non-generic methods.
  210. </remarks>
  211. </member>
  212. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  213. <summary>
  214. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  215. </summary>
  216. <param name="libraryName">Name of the library containing the import.</param>
  217. </member>
  218. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  219. <summary>
  220. Gets the name of the library containing the import.
  221. </summary>
  222. </member>
  223. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  224. <summary>
  225. Gets or sets the name of the entry point to be called.
  226. </summary>
  227. </member>
  228. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  229. <summary>
  230. Gets or sets how to marshal string arguments to the method.
  231. </summary>
  232. <remarks>
  233. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  234. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  235. </remarks>
  236. </member>
  237. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  238. <summary>
  239. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  240. </summary>
  241. <remarks>
  242. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  243. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  244. </remarks>
  245. </member>
  246. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  247. <summary>
  248. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  249. on other platforms) before returning from the attributed method.
  250. </summary>
  251. </member>
  252. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  253. <summary>
  254. Specifies how strings should be marshalled for generated p/invokes
  255. </summary>
  256. </member>
  257. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  258. <summary>
  259. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  260. </summary>
  261. </member>
  262. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  263. <summary>
  264. Use the platform-provided UTF-8 marshaller.
  265. </summary>
  266. </member>
  267. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  268. <summary>
  269. Use the platform-provided UTF-16 marshaller.
  270. </summary>
  271. </member>
  272. </members>
  273. </doc>