Microsoft.Extensions.Logging.Console.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.Console</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.Console.AnsiLogConsole">
  8. <summary>
  9. For consoles which understand the ANSI escape code sequences to represent color
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Logging.Console.AnsiParser.Parse(System.String)">
  13. <summary>
  14. Parses a subset of display attributes
  15. Set Display Attributes
  16. Set Attribute Mode [{attr1};...;{attrn}m
  17. Sets multiple display attribute settings. The following lists standard attributes that are getting parsed:
  18. 1 Bright
  19. Foreground Colours
  20. 30 Black
  21. 31 Red
  22. 32 Green
  23. 33 Yellow
  24. 34 Blue
  25. 35 Magenta
  26. 36 Cyan
  27. 37 White
  28. Background Colours
  29. 40 Black
  30. 41 Red
  31. 42 Green
  32. 43 Yellow
  33. 44 Blue
  34. 45 Magenta
  35. 46 Cyan
  36. 47 White
  37. </summary>
  38. </member>
  39. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatter">
  40. <summary>
  41. Allows custom log messages formatting
  42. </summary>
  43. </member>
  44. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Name">
  45. <summary>
  46. Gets the name associated with the console log formatter.
  47. </summary>
  48. </member>
  49. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleFormatter.Write``1(Microsoft.Extensions.Logging.Abstractions.LogEntry{``0}@,Microsoft.Extensions.Logging.IExternalScopeProvider,System.IO.TextWriter)">
  50. <summary>
  51. Writes the log message to the specified TextWriter.
  52. </summary>
  53. <remarks>
  54. if the formatter wants to write colors to the console, it can do so by embedding ANSI color codes into the string
  55. </remarks>
  56. <param name="logEntry">The log entry.</param>
  57. <param name="scopeProvider">The provider of scope data.</param>
  58. <param name="textWriter">The string writer embedding ansi code for colors.</param>
  59. <typeparam name="TState">The type of the object to be written.</typeparam>
  60. </member>
  61. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames">
  62. <summary>
  63. Reserved formatter names for the built-in console formatters.
  64. </summary>
  65. </member>
  66. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Simple">
  67. <summary>
  68. Reserved name for simple console formatter
  69. </summary>
  70. </member>
  71. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Json">
  72. <summary>
  73. Reserved name for json console formatter
  74. </summary>
  75. </member>
  76. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleFormatterNames.Systemd">
  77. <summary>
  78. Reserved name for systemd console formatter
  79. </summary>
  80. </member>
  81. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions">
  82. <summary>
  83. Options for the built-in console log formatter.
  84. </summary>
  85. </member>
  86. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.IncludeScopes">
  87. <summary>
  88. Includes scopes when <see langword="true" />.
  89. </summary>
  90. </member>
  91. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.TimestampFormat">
  92. <summary>
  93. Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
  94. </summary>
  95. </member>
  96. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions.UseUtcTimestamp">
  97. <summary>
  98. Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
  99. </summary>
  100. </member>
  101. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat">
  102. <summary>
  103. Format of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" /> messages.
  104. </summary>
  105. </member>
  106. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default">
  107. <summary>
  108. Produces messages in the default console format.
  109. </summary>
  110. </member>
  111. <member name="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Systemd">
  112. <summary>
  113. Produces messages in a format suitable for console output to the systemd journal.
  114. </summary>
  115. </member>
  116. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions">
  117. <summary>
  118. Options for a <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.
  119. </summary>
  120. </member>
  121. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors">
  122. <summary>
  123. Disables colors when <see langword="true" />.
  124. </summary>
  125. </member>
  126. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format">
  127. <summary>
  128. Gets or sets log message format. Defaults to <see cref="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default" />.
  129. </summary>
  130. </member>
  131. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.FormatterName">
  132. <summary>
  133. Name of the log message formatter to use. Defaults to "simple" />.
  134. </summary>
  135. </member>
  136. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes">
  137. <summary>
  138. Includes scopes when <see langword="true" />.
  139. </summary>
  140. </member>
  141. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.LogToStandardErrorThreshold">
  142. <summary>
  143. Gets or sets value indicating the minimum level of messages that would get written to <c>Console.Error</c>.
  144. </summary>
  145. </member>
  146. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat">
  147. <summary>
  148. Gets or sets format string used to format timestamp in logging messages. Defaults to <c>null</c>.
  149. </summary>
  150. </member>
  151. <member name="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp">
  152. <summary>
  153. Gets or sets indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to <c>false</c>.
  154. </summary>
  155. </member>
  156. <member name="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider">
  157. <summary>
  158. A provider of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances.
  159. </summary>
  160. </member>
  161. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
  162. <summary>
  163. Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
  164. </summary>
  165. <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.Console.ConsoleFormatter})">
  168. <summary>
  169. Creates an instance of <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider"/>.
  170. </summary>
  171. <param name="options">The options to create <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> instances with.</param>
  172. <param name="formatters">Log formatters added for <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> insteaces.</param>
  173. </member>
  174. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.CreateLogger(System.String)">
  175. <inheritdoc />
  176. </member>
  177. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.Dispose">
  178. <inheritdoc />
  179. </member>
  180. <member name="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerProvider.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  181. <inheritdoc />
  182. </member>
  183. <member name="T:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions">
  184. <summary>
  185. Options for the built-in json console log formatter.
  186. </summary>
  187. </member>
  188. <member name="P:Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions.JsonWriterOptions">
  189. <summary>
  190. Gets or sets JsonWriterOptions.
  191. </summary>
  192. </member>
  193. <member name="T:Microsoft.Extensions.Logging.Console.LoggerColorBehavior">
  194. <summary>
  195. Determines when to use color when logging messages.
  196. </summary>
  197. </member>
  198. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Default">
  199. <summary>
  200. Use the default color behavior, enabling color except when the console output is redirected.
  201. </summary>
  202. <remarks>
  203. Enables color except when the console output is redirected.
  204. </remarks>
  205. </member>
  206. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Enabled">
  207. <summary>
  208. Enable color for logging
  209. </summary>
  210. </member>
  211. <member name="F:Microsoft.Extensions.Logging.Console.LoggerColorBehavior.Disabled">
  212. <summary>
  213. Disable color for logging
  214. </summary>
  215. </member>
  216. <member name="T:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions">
  217. <summary>
  218. Options for the built-in default console log formatter.
  219. </summary>
  220. </member>
  221. <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.ColorBehavior">
  222. <summary>
  223. Determines when to use color when logging messages.
  224. </summary>
  225. </member>
  226. <member name="P:Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions.SingleLine">
  227. <summary>
  228. When <see langword="true" />, the entire message gets logged in a single line.
  229. </summary>
  230. </member>
  231. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  232. <summary>
  233. Adds a console logger named 'Console' to the factory.
  234. </summary>
  235. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  236. </member>
  237. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
  238. <summary>
  239. Adds a console logger named 'Console' to the factory.
  240. </summary>
  241. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  242. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>.</param>
  243. </member>
  244. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  245. <summary>
  246. Add the default console log formatter named 'simple' to the factory with default properties.
  247. </summary>
  248. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  249. </member>
  250. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSimpleConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.SimpleConsoleFormatterOptions})">
  251. <summary>
  252. Add and configure a console log formatter named 'simple' to the factory.
  253. </summary>
  254. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  255. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in default log formatter.</param>
  256. </member>
  257. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  258. <summary>
  259. Add a console log formatter named 'json' to the factory with default properties.
  260. </summary>
  261. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  262. </member>
  263. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddJsonConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.JsonConsoleFormatterOptions})">
  264. <summary>
  265. Add and configure a console log formatter named 'json' to the factory.
  266. </summary>
  267. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  268. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in json log formatter.</param>
  269. </member>
  270. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleFormatterOptions})">
  271. <summary>
  272. Add and configure a console log formatter named 'systemd' to the factory.
  273. </summary>
  274. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  275. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/> options for the built-in systemd log formatter.</param>
  276. </member>
  277. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddSystemdConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
  278. <summary>
  279. Add a console log formatter named 'systemd' to the factory with default properties.
  280. </summary>
  281. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  282. </member>
  283. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder)">
  284. <summary>
  285. Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
  286. </summary>
  287. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  288. </member>
  289. <member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsoleFormatter``2(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{``1})">
  290. <summary>
  291. Adds a custom console logger formatter 'TFormatter' to be configured with options 'TOptions'.
  292. </summary>
  293. <param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
  294. <param name="configure">A delegate to configure options 'TOptions' for custom formatter 'TFormatter'.</param>
  295. </member>
  296. <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
  297. <summary>
  298. Scope provider that does nothing.
  299. </summary>
  300. </member>
  301. <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
  302. <summary>
  303. Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
  304. </summary>
  305. </member>
  306. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
  307. <inheritdoc />
  308. </member>
  309. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
  310. <inheritdoc />
  311. </member>
  312. <member name="T:Microsoft.Extensions.Logging.NullScope">
  313. <summary>
  314. An empty scope without any logic
  315. </summary>
  316. </member>
  317. <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
  318. <inheritdoc />
  319. </member>
  320. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  321. <summary>
  322. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  323. for example through <see cref="N:System.Reflection"/>.
  324. </summary>
  325. <remarks>
  326. This allows tools to understand which members are being accessed during the execution
  327. of a program.
  328. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  329. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  330. that the string represents a fully qualified type name.
  331. When this attribute is applied to a class, interface, or struct, the members specified
  332. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  333. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  334. If the attribute is applied to a method it's treated as a special case and it implies
  335. the attribute should be applied to the "this" parameter of the method. As such the attribute
  336. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  337. will use it there).
  338. </remarks>
  339. </member>
  340. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  341. <summary>
  342. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  343. with the specified member types.
  344. </summary>
  345. <param name="memberTypes">The types of members dynamically accessed.</param>
  346. </member>
  347. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  348. <summary>
  349. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  350. of members dynamically accessed.
  351. </summary>
  352. </member>
  353. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  354. <summary>
  355. Specifies the types of members that are dynamically accessed.
  356. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  357. bitwise combination of its member values.
  358. </summary>
  359. </member>
  360. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  361. <summary>
  362. Specifies no members.
  363. </summary>
  364. </member>
  365. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  366. <summary>
  367. Specifies the default, parameterless public constructor.
  368. </summary>
  369. </member>
  370. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  371. <summary>
  372. Specifies all public constructors.
  373. </summary>
  374. </member>
  375. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  376. <summary>
  377. Specifies all non-public constructors.
  378. </summary>
  379. </member>
  380. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  381. <summary>
  382. Specifies all public methods.
  383. </summary>
  384. </member>
  385. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  386. <summary>
  387. Specifies all non-public methods.
  388. </summary>
  389. </member>
  390. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  391. <summary>
  392. Specifies all public fields.
  393. </summary>
  394. </member>
  395. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  396. <summary>
  397. Specifies all non-public fields.
  398. </summary>
  399. </member>
  400. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  401. <summary>
  402. Specifies all public nested types.
  403. </summary>
  404. </member>
  405. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  406. <summary>
  407. Specifies all non-public nested types.
  408. </summary>
  409. </member>
  410. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  411. <summary>
  412. Specifies all public properties.
  413. </summary>
  414. </member>
  415. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  416. <summary>
  417. Specifies all non-public properties.
  418. </summary>
  419. </member>
  420. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  421. <summary>
  422. Specifies all public events.
  423. </summary>
  424. </member>
  425. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  426. <summary>
  427. Specifies all non-public events.
  428. </summary>
  429. </member>
  430. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  431. <summary>
  432. Specifies all interfaces implemented by the type.
  433. </summary>
  434. </member>
  435. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  436. <summary>
  437. Specifies all members.
  438. </summary>
  439. </member>
  440. <member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
  441. <summary>
  442. Indicates that the specified method requires dynamic access to code that is not referenced
  443. statically, for example through <see cref="N:System.Reflection"/>.
  444. </summary>
  445. <remarks>
  446. This allows tools to understand which methods are unsafe to call when removing unreferenced
  447. code from an application.
  448. </remarks>
  449. </member>
  450. <member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
  451. <summary>
  452. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
  453. with the specified message.
  454. </summary>
  455. <param name="message">
  456. A message that contains information about the usage of unreferenced code.
  457. </param>
  458. </member>
  459. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
  460. <summary>
  461. Gets a message that contains information about the usage of unreferenced code.
  462. </summary>
  463. </member>
  464. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
  465. <summary>
  466. Gets or sets an optional URL that contains more information about the method,
  467. why it requries unreferenced code, and what options a consumer has to deal with it.
  468. </summary>
  469. </member>
  470. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  471. <summary>
  472. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  473. single code artifact.
  474. </summary>
  475. <remarks>
  476. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  477. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  478. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  479. </remarks>
  480. </member>
  481. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  482. <summary>
  483. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  484. class, specifying the category of the tool and the identifier for an analysis rule.
  485. </summary>
  486. <param name="category">The category for the attribute.</param>
  487. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  488. </member>
  489. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  490. <summary>
  491. Gets the category identifying the classification of the attribute.
  492. </summary>
  493. <remarks>
  494. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  495. for which a message suppression attribute applies.
  496. </remarks>
  497. </member>
  498. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  499. <summary>
  500. Gets the identifier of the analysis tool rule to be suppressed.
  501. </summary>
  502. <remarks>
  503. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  504. properties form a unique check identifier.
  505. </remarks>
  506. </member>
  507. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  508. <summary>
  509. Gets or sets the scope of the code that is relevant for the attribute.
  510. </summary>
  511. <remarks>
  512. The Scope property is an optional argument that specifies the metadata scope for which
  513. the attribute is relevant.
  514. </remarks>
  515. </member>
  516. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  517. <summary>
  518. Gets or sets a fully qualified path that represents the target of the attribute.
  519. </summary>
  520. <remarks>
  521. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  522. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  523. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  524. The analysis tool user interface should be capable of automatically formatting the parameter.
  525. </remarks>
  526. </member>
  527. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  528. <summary>
  529. Gets or sets an optional argument expanding on exclusion criteria.
  530. </summary>
  531. <remarks>
  532. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  533. exclusion where the literal metadata target is not sufficiently precise. For example,
  534. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  535. and it may be desirable to suppress a violation against a statement in the method that will
  536. give a rule violation, but not against all statements in the method.
  537. </remarks>
  538. </member>
  539. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  540. <summary>
  541. Gets or sets the justification for suppressing the code analysis message.
  542. </summary>
  543. </member>
  544. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  545. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  546. </member>
  547. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  548. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  549. </member>
  550. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  551. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  552. </member>
  553. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  554. <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>
  555. </member>
  556. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  557. <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>
  558. </member>
  559. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  560. <summary>Initializes the attribute with the specified return value condition.</summary>
  561. <param name="returnValue">
  562. The return value condition. If the method returns this value, the associated parameter may be null.
  563. </param>
  564. </member>
  565. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  566. <summary>Gets the return value condition.</summary>
  567. </member>
  568. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  569. <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>
  570. </member>
  571. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  572. <summary>Initializes the attribute with the specified return value condition.</summary>
  573. <param name="returnValue">
  574. The return value condition. If the method returns this value, the associated parameter will not be null.
  575. </param>
  576. </member>
  577. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  578. <summary>Gets the return value condition.</summary>
  579. </member>
  580. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  581. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  582. </member>
  583. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  584. <summary>Initializes the attribute with the associated parameter name.</summary>
  585. <param name="parameterName">
  586. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  587. </param>
  588. </member>
  589. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  590. <summary>Gets the associated parameter name.</summary>
  591. </member>
  592. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  593. <summary>Applied to a method that will never return under any circumstance.</summary>
  594. </member>
  595. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  596. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  597. </member>
  598. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  599. <summary>Initializes the attribute with the specified parameter value.</summary>
  600. <param name="parameterValue">
  601. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  602. the associated parameter matches this value.
  603. </param>
  604. </member>
  605. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  606. <summary>Gets the condition parameter value.</summary>
  607. </member>
  608. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  609. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  610. </member>
  611. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  612. <summary>Initializes the attribute with a field or property member.</summary>
  613. <param name="member">
  614. The field or property member that is promised to be not-null.
  615. </param>
  616. </member>
  617. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  618. <summary>Initializes the attribute with the list of field and property members.</summary>
  619. <param name="members">
  620. The list of field and property members that are promised to be not-null.
  621. </param>
  622. </member>
  623. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  624. <summary>Gets field or property member names.</summary>
  625. </member>
  626. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  627. <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>
  628. </member>
  629. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  630. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  631. <param name="returnValue">
  632. The return value condition. If the method returns this value, the associated parameter will not be null.
  633. </param>
  634. <param name="member">
  635. The field or property member that is promised to be not-null.
  636. </param>
  637. </member>
  638. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  639. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  640. <param name="returnValue">
  641. The return value condition. If the method returns this value, the associated parameter will not be null.
  642. </param>
  643. <param name="members">
  644. The list of field and property members that are promised to be not-null.
  645. </param>
  646. </member>
  647. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  648. <summary>Gets the return value condition.</summary>
  649. </member>
  650. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  651. <summary>Gets field or property member names.</summary>
  652. </member>
  653. <member name="P:System.SR.BufferMaximumSizeExceeded">
  654. <summary>Cannot allocate a buffer of size {0}.</summary>
  655. </member>
  656. <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
  657. <summary>
  658. Base type for all platform-specific API attributes.
  659. </summary>
  660. </member>
  661. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  662. <summary>
  663. Records the platform that the project targeted.
  664. </summary>
  665. </member>
  666. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  667. <summary>
  668. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  669. applied to indicate support on multiple operating systems.
  670. </summary>
  671. <remarks>
  672. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  673. or use guards to prevent calls to APIs on unsupported operating systems.
  674. A given platform should only be specified once.
  675. </remarks>
  676. </member>
  677. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  678. <summary>
  679. Marks APIs that were removed in a given operating system version.
  680. </summary>
  681. <remarks>
  682. Primarily used by OS bindings to indicate APIs that are only available in
  683. earlier versions.
  684. </remarks>
  685. </member>
  686. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  687. <summary>
  688. Annotates a custom guard field, property or method with a supported platform name and optional version.
  689. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  690. </summary>
  691. <remarks>
  692. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  693. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  694. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  695. </remarks>
  696. </member>
  697. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  698. <summary>
  699. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  700. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  701. </summary>
  702. <remarks>
  703. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  704. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  705. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  706. </remarks>
  707. </member>
  708. </members>
  709. </doc>