Microsoft.Extensions.Options.ConfigurationExtensions.xml 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599
  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.Runtime.InteropServices.LibraryImportAttribute">
  161. <summary>
  162. Attribute used to indicate a source generator should create a function for marshalling
  163. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  164. </summary>
  165. <remarks>
  166. This attribute is meaningless if the source generator associated with it is not enabled.
  167. The current built-in source generator only supports C# and only supplies an implementation when
  168. applied to static, partial, non-generic methods.
  169. </remarks>
  170. </member>
  171. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  172. <summary>
  173. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  174. </summary>
  175. <param name="libraryName">Name of the library containing the import.</param>
  176. </member>
  177. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  178. <summary>
  179. Gets the name of the library containing the import.
  180. </summary>
  181. </member>
  182. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  183. <summary>
  184. Gets or sets the name of the entry point to be called.
  185. </summary>
  186. </member>
  187. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  188. <summary>
  189. Gets or sets how to marshal string arguments to the method.
  190. </summary>
  191. <remarks>
  192. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  193. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  194. </remarks>
  195. </member>
  196. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  197. <summary>
  198. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  199. </summary>
  200. <remarks>
  201. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  202. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  203. </remarks>
  204. </member>
  205. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  206. <summary>
  207. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  208. on other platforms) before returning from the attributed method.
  209. </summary>
  210. </member>
  211. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  212. <summary>
  213. Specifies how strings should be marshalled for generated p/invokes
  214. </summary>
  215. </member>
  216. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  217. <summary>
  218. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  219. </summary>
  220. </member>
  221. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  222. <summary>
  223. Use the platform-provided UTF-8 marshaller.
  224. </summary>
  225. </member>
  226. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  227. <summary>
  228. Use the platform-provided UTF-16 marshaller.
  229. </summary>
  230. </member>
  231. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  232. <summary>
  233. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  234. for example through <see cref="N:System.Reflection"/>.
  235. </summary>
  236. <remarks>
  237. This allows tools to understand which members are being accessed during the execution
  238. of a program.
  239. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  240. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  241. that the string represents a fully qualified type name.
  242. When this attribute is applied to a class, interface, or struct, the members specified
  243. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  244. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  245. If the attribute is applied to a method it's treated as a special case and it implies
  246. the attribute should be applied to the "this" parameter of the method. As such the attribute
  247. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  248. will use it there).
  249. </remarks>
  250. </member>
  251. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  252. <summary>
  253. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  254. with the specified member types.
  255. </summary>
  256. <param name="memberTypes">The types of members dynamically accessed.</param>
  257. </member>
  258. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  259. <summary>
  260. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  261. of members dynamically accessed.
  262. </summary>
  263. </member>
  264. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  265. <summary>
  266. Specifies the types of members that are dynamically accessed.
  267. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  268. bitwise combination of its member values.
  269. </summary>
  270. </member>
  271. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  272. <summary>
  273. Specifies no members.
  274. </summary>
  275. </member>
  276. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  277. <summary>
  278. Specifies the default, parameterless public constructor.
  279. </summary>
  280. </member>
  281. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  282. <summary>
  283. Specifies all public constructors.
  284. </summary>
  285. </member>
  286. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  287. <summary>
  288. Specifies all non-public constructors.
  289. </summary>
  290. </member>
  291. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  292. <summary>
  293. Specifies all public methods.
  294. </summary>
  295. </member>
  296. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  297. <summary>
  298. Specifies all non-public methods.
  299. </summary>
  300. </member>
  301. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  302. <summary>
  303. Specifies all public fields.
  304. </summary>
  305. </member>
  306. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  307. <summary>
  308. Specifies all non-public fields.
  309. </summary>
  310. </member>
  311. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  312. <summary>
  313. Specifies all public nested types.
  314. </summary>
  315. </member>
  316. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  317. <summary>
  318. Specifies all non-public nested types.
  319. </summary>
  320. </member>
  321. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  322. <summary>
  323. Specifies all public properties.
  324. </summary>
  325. </member>
  326. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  327. <summary>
  328. Specifies all non-public properties.
  329. </summary>
  330. </member>
  331. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  332. <summary>
  333. Specifies all public events.
  334. </summary>
  335. </member>
  336. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  337. <summary>
  338. Specifies all non-public events.
  339. </summary>
  340. </member>
  341. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  342. <summary>
  343. Specifies all interfaces implemented by the type.
  344. </summary>
  345. </member>
  346. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  347. <summary>
  348. Specifies all members.
  349. </summary>
  350. </member>
  351. <member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
  352. <summary>
  353. Indicates that the specified method requires dynamic access to code that is not referenced
  354. statically, for example through <see cref="N:System.Reflection"/>.
  355. </summary>
  356. <remarks>
  357. This allows tools to understand which methods are unsafe to call when removing unreferenced
  358. code from an application.
  359. </remarks>
  360. </member>
  361. <member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
  362. <summary>
  363. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
  364. with the specified message.
  365. </summary>
  366. <param name="message">
  367. A message that contains information about the usage of unreferenced code.
  368. </param>
  369. </member>
  370. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
  371. <summary>
  372. Gets a message that contains information about the usage of unreferenced code.
  373. </summary>
  374. </member>
  375. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
  376. <summary>
  377. Gets or sets an optional URL that contains more information about the method,
  378. why it requires unreferenced code, and what options a consumer has to deal with it.
  379. </summary>
  380. </member>
  381. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  382. <summary>
  383. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  384. single code artifact.
  385. </summary>
  386. <remarks>
  387. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  388. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  389. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  390. </remarks>
  391. </member>
  392. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  393. <summary>
  394. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  395. class, specifying the category of the tool and the identifier for an analysis rule.
  396. </summary>
  397. <param name="category">The category for the attribute.</param>
  398. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  399. </member>
  400. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  401. <summary>
  402. Gets the category identifying the classification of the attribute.
  403. </summary>
  404. <remarks>
  405. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  406. for which a message suppression attribute applies.
  407. </remarks>
  408. </member>
  409. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  410. <summary>
  411. Gets the identifier of the analysis tool rule to be suppressed.
  412. </summary>
  413. <remarks>
  414. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  415. properties form a unique check identifier.
  416. </remarks>
  417. </member>
  418. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  419. <summary>
  420. Gets or sets the scope of the code that is relevant for the attribute.
  421. </summary>
  422. <remarks>
  423. The Scope property is an optional argument that specifies the metadata scope for which
  424. the attribute is relevant.
  425. </remarks>
  426. </member>
  427. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  428. <summary>
  429. Gets or sets a fully qualified path that represents the target of the attribute.
  430. </summary>
  431. <remarks>
  432. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  433. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  434. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  435. The analysis tool user interface should be capable of automatically formatting the parameter.
  436. </remarks>
  437. </member>
  438. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  439. <summary>
  440. Gets or sets an optional argument expanding on exclusion criteria.
  441. </summary>
  442. <remarks>
  443. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  444. exclusion where the literal metadata target is not sufficiently precise. For example,
  445. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  446. and it may be desirable to suppress a violation against a statement in the method that will
  447. give a rule violation, but not against all statements in the method.
  448. </remarks>
  449. </member>
  450. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  451. <summary>
  452. Gets or sets the justification for suppressing the code analysis message.
  453. </summary>
  454. </member>
  455. <member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
  456. <summary>
  457. Indicates that the specified method requires the ability to generate new code at runtime,
  458. for example through <see cref="N:System.Reflection"/>.
  459. </summary>
  460. <remarks>
  461. This allows tools to understand which methods are unsafe to call when compiling ahead of time.
  462. </remarks>
  463. </member>
  464. <member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
  465. <summary>
  466. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
  467. with the specified message.
  468. </summary>
  469. <param name="message">
  470. A message that contains information about the usage of dynamic code.
  471. </param>
  472. </member>
  473. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
  474. <summary>
  475. Gets a message that contains information about the usage of dynamic code.
  476. </summary>
  477. </member>
  478. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
  479. <summary>
  480. Gets or sets an optional URL that contains more information about the method,
  481. why it requires dynamic code, and what options a consumer has to deal with it.
  482. </summary>
  483. </member>
  484. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  485. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  486. </member>
  487. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  488. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  489. </member>
  490. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  491. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  492. </member>
  493. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  494. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  495. </member>
  496. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  497. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  498. </member>
  499. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  500. <summary>Initializes the attribute with the specified return value condition.</summary>
  501. <param name="returnValue">
  502. The return value condition. If the method returns this value, the associated parameter may be null.
  503. </param>
  504. </member>
  505. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  506. <summary>Gets the return value condition.</summary>
  507. </member>
  508. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  509. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  510. </member>
  511. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  512. <summary>Initializes the attribute with the specified return value condition.</summary>
  513. <param name="returnValue">
  514. The return value condition. If the method returns this value, the associated parameter will not be null.
  515. </param>
  516. </member>
  517. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  518. <summary>Gets the return value condition.</summary>
  519. </member>
  520. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  521. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  522. </member>
  523. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  524. <summary>Initializes the attribute with the associated parameter name.</summary>
  525. <param name="parameterName">
  526. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  527. </param>
  528. </member>
  529. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  530. <summary>Gets the associated parameter name.</summary>
  531. </member>
  532. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  533. <summary>Applied to a method that will never return under any circumstance.</summary>
  534. </member>
  535. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  536. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  537. </member>
  538. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  539. <summary>Initializes the attribute with the specified parameter value.</summary>
  540. <param name="parameterValue">
  541. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  542. the associated parameter matches this value.
  543. </param>
  544. </member>
  545. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  546. <summary>Gets the condition parameter value.</summary>
  547. </member>
  548. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  549. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  550. </member>
  551. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  552. <summary>Initializes the attribute with a field or property member.</summary>
  553. <param name="member">
  554. The field or property member that is promised to be not-null.
  555. </param>
  556. </member>
  557. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  558. <summary>Initializes the attribute with the list of field and property members.</summary>
  559. <param name="members">
  560. The list of field and property members that are promised to be not-null.
  561. </param>
  562. </member>
  563. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  564. <summary>Gets field or property member names.</summary>
  565. </member>
  566. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  567. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  568. </member>
  569. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  570. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  571. <param name="returnValue">
  572. The return value condition. If the method returns this value, the associated parameter will not be null.
  573. </param>
  574. <param name="member">
  575. The field or property member that is promised to be not-null.
  576. </param>
  577. </member>
  578. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  579. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  580. <param name="returnValue">
  581. The return value condition. If the method returns this value, the associated parameter will not be null.
  582. </param>
  583. <param name="members">
  584. The list of field and property members that are promised to be not-null.
  585. </param>
  586. </member>
  587. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  588. <summary>Gets the return value condition.</summary>
  589. </member>
  590. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  591. <summary>Gets field or property member names.</summary>
  592. </member>
  593. </members>
  594. </doc>