Microsoft.Extensions.Logging.Abstractions.xml 74 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.EventId">
  8. <summary>
  9. Identifies a logging event. The primary identifier is the "Id" property, with the "Name" property providing a short description of this type of event.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Logging.EventId.op_Implicit(System.Int32)~Microsoft.Extensions.Logging.EventId">
  13. <summary>
  14. Implicitly creates an EventId from the given <see cref="T:System.Int32"/>.
  15. </summary>
  16. <param name="i">The <see cref="T:System.Int32"/> to convert to an EventId.</param>
  17. </member>
  18. <member name="M:Microsoft.Extensions.Logging.EventId.op_Equality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
  19. <summary>
  20. Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId"/> instances have the same value. They are equal if they have the same Id.
  21. </summary>
  22. <param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
  23. <param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
  24. <returns><see langword="true" /> if the objects are equal.</returns>
  25. </member>
  26. <member name="M:Microsoft.Extensions.Logging.EventId.op_Inequality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
  27. <summary>
  28. Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId"/> instances have different values.
  29. </summary>
  30. <param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
  31. <param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
  32. <returns><see langword="true" /> if the objects are not equal.</returns>
  33. </member>
  34. <member name="M:Microsoft.Extensions.Logging.EventId.#ctor(System.Int32,System.String)">
  35. <summary>
  36. Initializes an instance of the <see cref="T:Microsoft.Extensions.Logging.EventId"/> struct.
  37. </summary>
  38. <param name="id">The numeric identifier for this event.</param>
  39. <param name="name">The name of this event.</param>
  40. </member>
  41. <member name="P:Microsoft.Extensions.Logging.EventId.Id">
  42. <summary>
  43. Gets the numeric identifier for this event.
  44. </summary>
  45. </member>
  46. <member name="P:Microsoft.Extensions.Logging.EventId.Name">
  47. <summary>
  48. Gets the name of this event.
  49. </summary>
  50. </member>
  51. <member name="M:Microsoft.Extensions.Logging.EventId.ToString">
  52. <inheritdoc />
  53. </member>
  54. <member name="M:Microsoft.Extensions.Logging.EventId.Equals(Microsoft.Extensions.Logging.EventId)">
  55. <summary>
  56. Indicates whether the current object is equal to another object of the same type. Two events are equal if they have the same id.
  57. </summary>
  58. <param name="other">An object to compare with this object.</param>
  59. <returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
  60. </member>
  61. <member name="M:Microsoft.Extensions.Logging.EventId.Equals(System.Object)">
  62. <inheritdoc />
  63. </member>
  64. <member name="M:Microsoft.Extensions.Logging.EventId.GetHashCode">
  65. <inheritdoc />
  66. </member>
  67. <member name="T:Microsoft.Extensions.Logging.FormattedLogValues">
  68. <summary>
  69. LogValues to enable formatting options supported by <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object)"/>.
  70. This also enables using {NamedformatItem} in the format string.
  71. </summary>
  72. </member>
  73. <member name="T:Microsoft.Extensions.Logging.IExternalScopeProvider">
  74. <summary>
  75. Represents a storage of common scope data.
  76. </summary>
  77. </member>
  78. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  79. <summary>
  80. Executes callback for each currently active scope objects in order of creation.
  81. All callbacks are guaranteed to be called inline from this method.
  82. </summary>
  83. <param name="callback">The callback to be executed for every scope object</param>
  84. <param name="state">The state object to be passed into the callback</param>
  85. <typeparam name="TState">The type of state to accept.</typeparam>
  86. </member>
  87. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.Push(System.Object)">
  88. <summary>
  89. Adds scope object to the list
  90. </summary>
  91. <param name="state">The scope object</param>
  92. <returns>The <see cref="T:System.IDisposable"/> token that removes scope on dispose.</returns>
  93. </member>
  94. <member name="T:Microsoft.Extensions.Logging.ILogger">
  95. <summary>
  96. Represents a type used to perform logging.
  97. </summary>
  98. <remarks>Aggregates most logging patterns to a single method.</remarks>
  99. </member>
  100. <member name="M:Microsoft.Extensions.Logging.ILogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  101. <summary>
  102. Writes a log entry.
  103. </summary>
  104. <param name="logLevel">Entry will be written on this level.</param>
  105. <param name="eventId">Id of the event.</param>
  106. <param name="state">The entry to be written. Can be also an object.</param>
  107. <param name="exception">The exception related to this entry.</param>
  108. <param name="formatter">Function to create a <see cref="T:System.String"/> message of the <paramref name="state"/> and <paramref name="exception"/>.</param>
  109. <typeparam name="TState">The type of the object to be written.</typeparam>
  110. </member>
  111. <member name="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  112. <summary>
  113. Checks if the given <paramref name="logLevel"/> is enabled.
  114. </summary>
  115. <param name="logLevel">Level to be checked.</param>
  116. <returns><c>true</c> if enabled.</returns>
  117. </member>
  118. <member name="M:Microsoft.Extensions.Logging.ILogger.BeginScope``1(``0)">
  119. <summary>
  120. Begins a logical operation scope.
  121. </summary>
  122. <param name="state">The identifier for the scope.</param>
  123. <typeparam name="TState">The type of the state to begin scope for.</typeparam>
  124. <returns>An <see cref="T:System.IDisposable"/> that ends the logical operation scope on dispose.</returns>
  125. </member>
  126. <member name="T:Microsoft.Extensions.Logging.ILoggerFactory">
  127. <summary>
  128. Represents a type used to configure the logging system and create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from
  129. the registered <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s.
  130. </summary>
  131. </member>
  132. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.CreateLogger(System.String)">
  133. <summary>
  134. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
  135. </summary>
  136. <param name="categoryName">The category name for messages produced by the logger.</param>
  137. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</returns>
  138. </member>
  139. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  140. <summary>
  141. Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to the logging system.
  142. </summary>
  143. <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.</param>
  144. </member>
  145. <member name="T:Microsoft.Extensions.Logging.ILoggerProvider">
  146. <summary>
  147. Represents a type that can create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
  148. </summary>
  149. </member>
  150. <member name="M:Microsoft.Extensions.Logging.ILoggerProvider.CreateLogger(System.String)">
  151. <summary>
  152. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
  153. </summary>
  154. <param name="categoryName">The category name for messages produced by the logger.</param>
  155. <returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
  156. </member>
  157. <member name="T:Microsoft.Extensions.Logging.ILogger`1">
  158. <summary>
  159. A generic interface for logging where the category name is derived from the specified
  160. <typeparamref name="TCategoryName"/> type name.
  161. Generally used to enable activation of a named <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from dependency injection.
  162. </summary>
  163. <typeparam name="TCategoryName">The type whose name is used for the logger category name.</typeparam>
  164. </member>
  165. <member name="T:Microsoft.Extensions.Logging.ISupportExternalScope">
  166. <summary>
  167. Represents a <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> that is able to consume external scope information.
  168. </summary>
  169. </member>
  170. <member name="M:Microsoft.Extensions.Logging.ISupportExternalScope.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  171. <summary>
  172. Sets external scope information source for logger provider.
  173. </summary>
  174. <param name="scopeProvider">The provider of scope data.</param>
  175. </member>
  176. <member name="T:Microsoft.Extensions.Logging.LogDefineOptions">
  177. <summary>
  178. Options for <see cref="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)"/> and its overloads
  179. </summary>
  180. </member>
  181. <member name="P:Microsoft.Extensions.Logging.LogDefineOptions.SkipEnabledCheck">
  182. <summary>
  183. Gets or sets the flag to skip IsEnabled check for the logging method.
  184. </summary>
  185. </member>
  186. <member name="T:Microsoft.Extensions.Logging.Abstractions.LogEntry`1">
  187. <summary>
  188. Holds the information for a single log entry.
  189. </summary>
  190. </member>
  191. <member name="M:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.#ctor(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.EventId,`0,System.Exception,System.Func{`0,System.Exception,System.String})">
  192. <summary>
  193. Initializes an instance of the LogEntry struct.
  194. </summary>
  195. <param name="logLevel">The log level.</param>
  196. <param name="category">The category name for the log.</param>
  197. <param name="eventId">The log event Id.</param>
  198. <param name="state">The state for which log is being written.</param>
  199. <param name="exception">The log exception.</param>
  200. <param name="formatter">The formatter.</param>
  201. </member>
  202. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.LogLevel">
  203. <summary>
  204. Gets the LogLevel
  205. </summary>
  206. </member>
  207. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Category">
  208. <summary>
  209. Gets the log category
  210. </summary>
  211. </member>
  212. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.EventId">
  213. <summary>
  214. Gets the log EventId
  215. </summary>
  216. </member>
  217. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.State">
  218. <summary>
  219. Gets the TState
  220. </summary>
  221. </member>
  222. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Exception">
  223. <summary>
  224. Gets the log exception
  225. </summary>
  226. </member>
  227. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Formatter">
  228. <summary>
  229. Gets the formatter
  230. </summary>
  231. </member>
  232. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger">
  233. <summary>
  234. Minimalistic logger that does nothing.
  235. </summary>
  236. </member>
  237. <member name="P:Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance">
  238. <summary>
  239. Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
  240. </summary>
  241. </member>
  242. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.BeginScope``1(``0)">
  243. <inheritdoc />
  244. </member>
  245. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  246. <inheritdoc />
  247. </member>
  248. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  249. <inheritdoc />
  250. </member>
  251. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
  252. <summary>
  253. An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> used to create instance of
  254. <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> that logs nothing.
  255. </summary>
  256. </member>
  257. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.#ctor">
  258. <summary>
  259. Creates a new <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory"/> instance.
  260. </summary>
  261. </member>
  262. <member name="F:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Instance">
  263. <summary>
  264. Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory"/>.
  265. </summary>
  266. </member>
  267. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.CreateLogger(System.String)">
  268. <inheritdoc />
  269. <remarks>
  270. This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> instance which logs nothing.
  271. </remarks>
  272. </member>
  273. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  274. <inheritdoc />
  275. <remarks>
  276. This method ignores the parameter and does nothing.
  277. </remarks>
  278. </member>
  279. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Dispose">
  280. <inheritdoc />
  281. </member>
  282. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
  283. <summary>
  284. Provider for the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
  285. </summary>
  286. </member>
  287. <member name="P:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Instance">
  288. <summary>
  289. Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider"/>.
  290. </summary>
  291. </member>
  292. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.CreateLogger(System.String)">
  293. <inheritdoc />
  294. </member>
  295. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Dispose">
  296. <inheritdoc />
  297. </member>
  298. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1">
  299. <summary>
  300. Minimalistic logger that does nothing.
  301. </summary>
  302. </member>
  303. <member name="F:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Instance">
  304. <summary>
  305. Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1"/>.
  306. </summary>
  307. <returns>An instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1"/>.</returns>
  308. </member>
  309. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.BeginScope``1(``0)">
  310. <inheritdoc />
  311. </member>
  312. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  313. <inheritdoc />
  314. <remarks>
  315. This method ignores the parameters and does nothing.
  316. </remarks>
  317. </member>
  318. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  319. <inheritdoc />
  320. </member>
  321. <member name="T:Microsoft.Extensions.Logging.LoggerExtensions">
  322. <summary>
  323. ILogger extension methods for common scenarios.
  324. </summary>
  325. </member>
  326. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  327. <summary>
  328. Formats and writes a debug log message.
  329. </summary>
  330. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  331. <param name="eventId">The event id associated with the log.</param>
  332. <param name="exception">The exception to log.</param>
  333. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  334. <param name="args">An object array that contains zero or more objects to format.</param>
  335. <example>logger.LogDebug(0, exception, "Error while processing request from {Address}", address)</example>
  336. </member>
  337. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  338. <summary>
  339. Formats and writes a debug log message.
  340. </summary>
  341. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  342. <param name="eventId">The event id associated with the log.</param>
  343. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  344. <param name="args">An object array that contains zero or more objects to format.</param>
  345. <example>logger.LogDebug(0, "Processing request from {Address}", address)</example>
  346. </member>
  347. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  348. <summary>
  349. Formats and writes a debug log message.
  350. </summary>
  351. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  352. <param name="exception">The exception to log.</param>
  353. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  354. <param name="args">An object array that contains zero or more objects to format.</param>
  355. <example>logger.LogDebug(exception, "Error while processing request from {Address}", address)</example>
  356. </member>
  357. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  358. <summary>
  359. Formats and writes a debug log message.
  360. </summary>
  361. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  362. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  363. <param name="args">An object array that contains zero or more objects to format.</param>
  364. <example>logger.LogDebug("Processing request from {Address}", address)</example>
  365. </member>
  366. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  367. <summary>
  368. Formats and writes a trace log message.
  369. </summary>
  370. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  371. <param name="eventId">The event id associated with the log.</param>
  372. <param name="exception">The exception to log.</param>
  373. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  374. <param name="args">An object array that contains zero or more objects to format.</param>
  375. <example>logger.LogTrace(0, exception, "Error while processing request from {Address}", address)</example>
  376. </member>
  377. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  378. <summary>
  379. Formats and writes a trace log message.
  380. </summary>
  381. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  382. <param name="eventId">The event id associated with the log.</param>
  383. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  384. <param name="args">An object array that contains zero or more objects to format.</param>
  385. <example>logger.LogTrace(0, "Processing request from {Address}", address)</example>
  386. </member>
  387. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  388. <summary>
  389. Formats and writes a trace log message.
  390. </summary>
  391. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  392. <param name="exception">The exception to log.</param>
  393. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  394. <param name="args">An object array that contains zero or more objects to format.</param>
  395. <example>logger.LogTrace(exception, "Error while processing request from {Address}", address)</example>
  396. </member>
  397. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  398. <summary>
  399. Formats and writes a trace log message.
  400. </summary>
  401. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  402. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  403. <param name="args">An object array that contains zero or more objects to format.</param>
  404. <example>logger.LogTrace("Processing request from {Address}", address)</example>
  405. </member>
  406. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  407. <summary>
  408. Formats and writes an informational log message.
  409. </summary>
  410. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  411. <param name="eventId">The event id associated with the log.</param>
  412. <param name="exception">The exception to log.</param>
  413. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  414. <param name="args">An object array that contains zero or more objects to format.</param>
  415. <example>logger.LogInformation(0, exception, "Error while processing request from {Address}", address)</example>
  416. </member>
  417. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  418. <summary>
  419. Formats and writes an informational log message.
  420. </summary>
  421. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  422. <param name="eventId">The event id associated with the log.</param>
  423. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  424. <param name="args">An object array that contains zero or more objects to format.</param>
  425. <example>logger.LogInformation(0, "Processing request from {Address}", address)</example>
  426. </member>
  427. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  428. <summary>
  429. Formats and writes an informational log message.
  430. </summary>
  431. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  432. <param name="exception">The exception to log.</param>
  433. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  434. <param name="args">An object array that contains zero or more objects to format.</param>
  435. <example>logger.LogInformation(exception, "Error while processing request from {Address}", address)</example>
  436. </member>
  437. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  438. <summary>
  439. Formats and writes an informational log message.
  440. </summary>
  441. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  442. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  443. <param name="args">An object array that contains zero or more objects to format.</param>
  444. <example>logger.LogInformation("Processing request from {Address}", address)</example>
  445. </member>
  446. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  447. <summary>
  448. Formats and writes a warning log message.
  449. </summary>
  450. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  451. <param name="eventId">The event id associated with the log.</param>
  452. <param name="exception">The exception to log.</param>
  453. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  454. <param name="args">An object array that contains zero or more objects to format.</param>
  455. <example>logger.LogWarning(0, exception, "Error while processing request from {Address}", address)</example>
  456. </member>
  457. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  458. <summary>
  459. Formats and writes a warning log message.
  460. </summary>
  461. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  462. <param name="eventId">The event id associated with the log.</param>
  463. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  464. <param name="args">An object array that contains zero or more objects to format.</param>
  465. <example>logger.LogWarning(0, "Processing request from {Address}", address)</example>
  466. </member>
  467. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  468. <summary>
  469. Formats and writes a warning log message.
  470. </summary>
  471. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  472. <param name="exception">The exception to log.</param>
  473. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  474. <param name="args">An object array that contains zero or more objects to format.</param>
  475. <example>logger.LogWarning(exception, "Error while processing request from {Address}", address)</example>
  476. </member>
  477. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  478. <summary>
  479. Formats and writes a warning log message.
  480. </summary>
  481. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  482. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  483. <param name="args">An object array that contains zero or more objects to format.</param>
  484. <example>logger.LogWarning("Processing request from {Address}", address)</example>
  485. </member>
  486. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  487. <summary>
  488. Formats and writes an error log message.
  489. </summary>
  490. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  491. <param name="eventId">The event id associated with the log.</param>
  492. <param name="exception">The exception to log.</param>
  493. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  494. <param name="args">An object array that contains zero or more objects to format.</param>
  495. <example>logger.LogError(0, exception, "Error while processing request from {Address}", address)</example>
  496. </member>
  497. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  498. <summary>
  499. Formats and writes an error log message.
  500. </summary>
  501. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  502. <param name="eventId">The event id associated with the log.</param>
  503. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  504. <param name="args">An object array that contains zero or more objects to format.</param>
  505. <example>logger.LogError(0, "Processing request from {Address}", address)</example>
  506. </member>
  507. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  508. <summary>
  509. Formats and writes an error log message.
  510. </summary>
  511. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  512. <param name="exception">The exception to log.</param>
  513. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  514. <param name="args">An object array that contains zero or more objects to format.</param>
  515. <example>logger.LogError(exception, "Error while processing request from {Address}", address)</example>
  516. </member>
  517. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  518. <summary>
  519. Formats and writes an error log message.
  520. </summary>
  521. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  522. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  523. <param name="args">An object array that contains zero or more objects to format.</param>
  524. <example>logger.LogError("Processing request from {Address}", address)</example>
  525. </member>
  526. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  527. <summary>
  528. Formats and writes a critical log message.
  529. </summary>
  530. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  531. <param name="eventId">The event id associated with the log.</param>
  532. <param name="exception">The exception to log.</param>
  533. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  534. <param name="args">An object array that contains zero or more objects to format.</param>
  535. <example>logger.LogCritical(0, exception, "Error while processing request from {Address}", address)</example>
  536. </member>
  537. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  538. <summary>
  539. Formats and writes a critical log message.
  540. </summary>
  541. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  542. <param name="eventId">The event id associated with the log.</param>
  543. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  544. <param name="args">An object array that contains zero or more objects to format.</param>
  545. <example>logger.LogCritical(0, "Processing request from {Address}", address)</example>
  546. </member>
  547. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  548. <summary>
  549. Formats and writes a critical log message.
  550. </summary>
  551. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  552. <param name="exception">The exception to log.</param>
  553. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  554. <param name="args">An object array that contains zero or more objects to format.</param>
  555. <example>logger.LogCritical(exception, "Error while processing request from {Address}", address)</example>
  556. </member>
  557. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  558. <summary>
  559. Formats and writes a critical log message.
  560. </summary>
  561. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  562. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  563. <param name="args">An object array that contains zero or more objects to format.</param>
  564. <example>logger.LogCritical("Processing request from {Address}", address)</example>
  565. </member>
  566. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.String,System.Object[])">
  567. <summary>
  568. Formats and writes a log message at the specified log level.
  569. </summary>
  570. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  571. <param name="logLevel">Entry will be written on this level.</param>
  572. <param name="message">Format string of the log message.</param>
  573. <param name="args">An object array that contains zero or more objects to format.</param>
  574. </member>
  575. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  576. <summary>
  577. Formats and writes a log message at the specified log level.
  578. </summary>
  579. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  580. <param name="logLevel">Entry will be written on this level.</param>
  581. <param name="eventId">The event id associated with the log.</param>
  582. <param name="message">Format string of the log message.</param>
  583. <param name="args">An object array that contains zero or more objects to format.</param>
  584. </member>
  585. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.Exception,System.String,System.Object[])">
  586. <summary>
  587. Formats and writes a log message at the specified log level.
  588. </summary>
  589. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  590. <param name="logLevel">Entry will be written on this level.</param>
  591. <param name="exception">The exception to log.</param>
  592. <param name="message">Format string of the log message.</param>
  593. <param name="args">An object array that contains zero or more objects to format.</param>
  594. </member>
  595. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  596. <summary>
  597. Formats and writes a log message at the specified log level.
  598. </summary>
  599. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
  600. <param name="logLevel">Entry will be written on this level.</param>
  601. <param name="eventId">The event id associated with the log.</param>
  602. <param name="exception">The exception to log.</param>
  603. <param name="message">Format string of the log message.</param>
  604. <param name="args">An object array that contains zero or more objects to format.</param>
  605. </member>
  606. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.BeginScope(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  607. <summary>
  608. Formats the message and creates a scope.
  609. </summary>
  610. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to create the scope in.</param>
  611. <param name="messageFormat">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  612. <param name="args">An object array that contains zero or more objects to format.</param>
  613. <returns>A disposable scope object. Can be null.</returns>
  614. <example>
  615. using(logger.BeginScope("Processing request from {Address}", address))
  616. {
  617. }
  618. </example>
  619. </member>
  620. <member name="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider">
  621. <summary>
  622. Default implementation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>
  623. </summary>
  624. </member>
  625. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.#ctor">
  626. <summary>
  627. Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider"/>.
  628. </summary>
  629. </member>
  630. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  631. <inheritdoc />
  632. </member>
  633. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.Push(System.Object)">
  634. <inheritdoc />
  635. </member>
  636. <member name="T:Microsoft.Extensions.Logging.LoggerFactoryExtensions">
  637. <summary>
  638. ILoggerFactory extension methods for common scenarios.
  639. </summary>
  640. </member>
  641. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger``1(Microsoft.Extensions.Logging.ILoggerFactory)">
  642. <summary>
  643. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type.
  644. </summary>
  645. <param name="factory">The factory.</param>
  646. <typeparam name="T">The type.</typeparam>
  647. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
  648. </member>
  649. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger(Microsoft.Extensions.Logging.ILoggerFactory,System.Type)">
  650. <summary>
  651. Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given <paramref name="type"/>.
  652. </summary>
  653. <param name="factory">The factory.</param>
  654. <param name="type">The type.</param>
  655. <return>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</return>
  656. </member>
  657. <member name="T:Microsoft.Extensions.Logging.LoggerMessage">
  658. <summary>
  659. Creates delegates which can be later cached to log messages in a performant way.
  660. </summary>
  661. </member>
  662. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope(System.String)">
  663. <summary>
  664. Creates a delegate which can be invoked to create a log scope.
  665. </summary>
  666. <param name="formatString">The named format string</param>
  667. <returns>A delegate which when invoked creates a log scope.</returns>
  668. </member>
  669. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``1(System.String)">
  670. <summary>
  671. Creates a delegate which can be invoked to create a log scope.
  672. </summary>
  673. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  674. <param name="formatString">The named format string</param>
  675. <returns>A delegate which when invoked creates a log scope.</returns>
  676. </member>
  677. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``2(System.String)">
  678. <summary>
  679. Creates a delegate which can be invoked to create a log scope.
  680. </summary>
  681. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  682. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  683. <param name="formatString">The named format string</param>
  684. <returns>A delegate which when invoked creates a log scope.</returns>
  685. </member>
  686. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``3(System.String)">
  687. <summary>
  688. Creates a delegate which can be invoked to create a log scope.
  689. </summary>
  690. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  691. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  692. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  693. <param name="formatString">The named format string</param>
  694. <returns>A delegate which when invoked creates a log scope.</returns>
  695. </member>
  696. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``4(System.String)">
  697. <summary>
  698. Creates a delegate which can be invoked to create a log scope.
  699. </summary>
  700. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  701. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  702. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  703. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  704. <param name="formatString">The named format string</param>
  705. <returns>A delegate which when invoked creates a log scope.</returns>
  706. </member>
  707. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``5(System.String)">
  708. <summary>
  709. Creates a delegate which can be invoked to create a log scope.
  710. </summary>
  711. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  712. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  713. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  714. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  715. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  716. <param name="formatString">The named format string</param>
  717. <returns>A delegate which when invoked creates a log scope.</returns>
  718. </member>
  719. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``6(System.String)">
  720. <summary>
  721. Creates a delegate which can be invoked to create a log scope.
  722. </summary>
  723. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  724. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  725. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  726. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  727. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  728. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  729. <param name="formatString">The named format string</param>
  730. <returns>A delegate which when invoked creates a log scope.</returns>
  731. </member>
  732. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  733. <summary>
  734. Creates a delegate which can be invoked for logging a message.
  735. </summary>
  736. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  737. <param name="eventId">The event id</param>
  738. <param name="formatString">The named format string</param>
  739. <returns>A delegate which when invoked creates a log message.</returns>
  740. </member>
  741. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  742. <summary>
  743. Creates a delegate which can be invoked for logging a message.
  744. </summary>
  745. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  746. <param name="eventId">The event id</param>
  747. <param name="formatString">The named format string</param>
  748. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  749. <returns>A delegate which when invoked creates a log message.</returns>
  750. </member>
  751. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  752. <summary>
  753. Creates a delegate which can be invoked for logging a message.
  754. </summary>
  755. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  756. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  757. <param name="eventId">The event id</param>
  758. <param name="formatString">The named format string</param>
  759. <returns>A delegate which when invoked creates a log message.</returns>
  760. </member>
  761. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  762. <summary>
  763. Creates a delegate which can be invoked for logging a message.
  764. </summary>
  765. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  766. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  767. <param name="eventId">The event id</param>
  768. <param name="formatString">The named format string</param>
  769. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  770. <returns>A delegate which when invoked creates a log message.</returns>
  771. </member>
  772. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  773. <summary>
  774. Creates a delegate which can be invoked for logging a message.
  775. </summary>
  776. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  777. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  778. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  779. <param name="eventId">The event id</param>
  780. <param name="formatString">The named format string</param>
  781. <returns>A delegate which when invoked creates a log message.</returns>
  782. </member>
  783. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  784. <summary>
  785. Creates a delegate which can be invoked for logging a message.
  786. </summary>
  787. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  788. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  789. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  790. <param name="eventId">The event id</param>
  791. <param name="formatString">The named format string</param>
  792. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  793. <returns>A delegate which when invoked creates a log message.</returns>
  794. </member>
  795. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  796. <summary>
  797. Creates a delegate which can be invoked for logging a message.
  798. </summary>
  799. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  800. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  801. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  802. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  803. <param name="eventId">The event id</param>
  804. <param name="formatString">The named format string</param>
  805. <returns>A delegate which when invoked creates a log message.</returns>
  806. </member>
  807. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  808. <summary>
  809. Creates a delegate which can be invoked for logging a message.
  810. </summary>
  811. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  812. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  813. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  814. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  815. <param name="eventId">The event id</param>
  816. <param name="formatString">The named format string</param>
  817. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  818. <returns>A delegate which when invoked creates a log message.</returns>
  819. </member>
  820. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  821. <summary>
  822. Creates a delegate which can be invoked for logging a message.
  823. </summary>
  824. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  825. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  826. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  827. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  828. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  829. <param name="eventId">The event id</param>
  830. <param name="formatString">The named format string</param>
  831. <returns>A delegate which when invoked creates a log message.</returns>
  832. </member>
  833. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  834. <summary>
  835. Creates a delegate which can be invoked for logging a message.
  836. </summary>
  837. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  838. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  839. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  840. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  841. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  842. <param name="eventId">The event id</param>
  843. <param name="formatString">The named format string</param>
  844. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  845. <returns>A delegate which when invoked creates a log message.</returns>
  846. </member>
  847. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  848. <summary>
  849. Creates a delegate which can be invoked for logging a message.
  850. </summary>
  851. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  852. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  853. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  854. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  855. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  856. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  857. <param name="eventId">The event id</param>
  858. <param name="formatString">The named format string</param>
  859. <returns>A delegate which when invoked creates a log message.</returns>
  860. </member>
  861. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  862. <summary>
  863. Creates a delegate which can be invoked for logging a message.
  864. </summary>
  865. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  866. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  867. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  868. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  869. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  870. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  871. <param name="eventId">The event id</param>
  872. <param name="formatString">The named format string</param>
  873. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  874. <returns>A delegate which when invoked creates a log message.</returns>
  875. </member>
  876. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  877. <summary>
  878. Creates a delegate which can be invoked for logging a message.
  879. </summary>
  880. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  881. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  882. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  883. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  884. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  885. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  886. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  887. <param name="eventId">The event id</param>
  888. <param name="formatString">The named format string</param>
  889. <returns>A delegate which when invoked creates a log message.</returns>
  890. </member>
  891. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  892. <summary>
  893. Creates a delegate which can be invoked for logging a message.
  894. </summary>
  895. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  896. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  897. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  898. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  899. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  900. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  901. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
  902. <param name="eventId">The event id</param>
  903. <param name="formatString">The named format string</param>
  904. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
  905. <returns>A delegate which when invoked creates a log message.</returns>
  906. </member>
  907. <member name="T:Microsoft.Extensions.Logging.LoggerMessageAttribute">
  908. <summary>
  909. Provides information to guide the production of a strongly-typed logging method.
  910. </summary>
  911. <remarks>
  912. <para>The method this attribute is applied to:</para>
  913. <para> - Must be a partial method.</para>
  914. <para> - Must return <c>void</c>.</para>
  915. <para> - Must not be generic.</para>
  916. <para> - Must have an <see cref="T:Microsoft.Extensions.Logging.ILogger"/> as one of its parameters.</para>
  917. <para> - Must have a <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> as one of its parameters.</para>
  918. <para> - None of the parameters can be generic.</para>
  919. </remarks>
  920. <example>
  921. <format type="text/markdown"><![CDATA[
  922. ```csharp
  923. static partial class Log
  924. {
  925. [LoggerMessage(EventId = 0, Message = "Could not open socket for {hostName}")]
  926. static partial void CouldNotOpenSocket(ILogger logger, LogLevel level, string hostName);
  927. }
  928. ```
  929. ]]></format>
  930. </example>
  931. </member>
  932. <member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor">
  933. <summary>
  934. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute"/> class
  935. which is used to guide the production of a strongly-typed logging method.
  936. </summary>
  937. </member>
  938. <member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor(System.Int32,Microsoft.Extensions.Logging.LogLevel,System.String)">
  939. <summary>
  940. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute"/> class
  941. which is used to guide the production of a strongly-typed logging method.
  942. </summary>
  943. <param name="eventId">The log event Id.</param>
  944. <param name="level">The log level.</param>
  945. <param name="message">Format string of the log message.</param>
  946. </member>
  947. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventId">
  948. <summary>
  949. Gets the logging event id for the logging method.
  950. </summary>
  951. </member>
  952. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventName">
  953. <summary>
  954. Gets or sets the logging event name for the logging method.
  955. </summary>
  956. <remarks>
  957. This will equal the method name if not specified.
  958. </remarks>
  959. </member>
  960. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Level">
  961. <summary>
  962. Gets the logging level for the logging method.
  963. </summary>
  964. </member>
  965. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Message">
  966. <summary>
  967. Gets the message text for the logging method.
  968. </summary>
  969. </member>
  970. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.SkipEnabledCheck">
  971. <summary>
  972. Gets the flag to skip IsEnabled check for the logging method.
  973. </summary>
  974. </member>
  975. <member name="T:Microsoft.Extensions.Logging.Logger`1">
  976. <summary>
  977. Delegates to a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type, created by the
  978. provided <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
  979. </summary>
  980. <typeparam name="T">The type.</typeparam>
  981. </member>
  982. <member name="M:Microsoft.Extensions.Logging.Logger`1.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
  983. <summary>
  984. Creates a new <see cref="T:Microsoft.Extensions.Logging.Logger`1"/>.
  985. </summary>
  986. <param name="factory">The factory.</param>
  987. </member>
  988. <member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#BeginScope``1(``0)">
  989. <inheritdoc />
  990. </member>
  991. <member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  992. <inheritdoc />
  993. </member>
  994. <member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  995. <inheritdoc />
  996. </member>
  997. <member name="T:Microsoft.Extensions.Logging.LogLevel">
  998. <summary>
  999. Defines logging severity levels.
  1000. </summary>
  1001. </member>
  1002. <member name="F:Microsoft.Extensions.Logging.LogLevel.Trace">
  1003. <summary>
  1004. Logs that contain the most detailed messages. These messages may contain sensitive application data.
  1005. These messages are disabled by default and should never be enabled in a production environment.
  1006. </summary>
  1007. </member>
  1008. <member name="F:Microsoft.Extensions.Logging.LogLevel.Debug">
  1009. <summary>
  1010. Logs that are used for interactive investigation during development. These logs should primarily contain
  1011. information useful for debugging and have no long-term value.
  1012. </summary>
  1013. </member>
  1014. <member name="F:Microsoft.Extensions.Logging.LogLevel.Information">
  1015. <summary>
  1016. Logs that track the general flow of the application. These logs should have long-term value.
  1017. </summary>
  1018. </member>
  1019. <member name="F:Microsoft.Extensions.Logging.LogLevel.Warning">
  1020. <summary>
  1021. Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
  1022. application execution to stop.
  1023. </summary>
  1024. </member>
  1025. <member name="F:Microsoft.Extensions.Logging.LogLevel.Error">
  1026. <summary>
  1027. Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
  1028. failure in the current activity, not an application-wide failure.
  1029. </summary>
  1030. </member>
  1031. <member name="F:Microsoft.Extensions.Logging.LogLevel.Critical">
  1032. <summary>
  1033. Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
  1034. immediate attention.
  1035. </summary>
  1036. </member>
  1037. <member name="F:Microsoft.Extensions.Logging.LogLevel.None">
  1038. <summary>
  1039. Not used for writing log messages. Specifies that a logging category should not write any messages.
  1040. </summary>
  1041. </member>
  1042. <member name="T:Microsoft.Extensions.Logging.LogValuesFormatter">
  1043. <summary>
  1044. Formatter to convert the named format items like {NamedformatItem} to <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object)"/> format.
  1045. </summary>
  1046. </member>
  1047. <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
  1048. <summary>
  1049. Scope provider that does nothing.
  1050. </summary>
  1051. </member>
  1052. <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
  1053. <summary>
  1054. Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
  1055. </summary>
  1056. </member>
  1057. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
  1058. <inheritdoc />
  1059. </member>
  1060. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
  1061. <inheritdoc />
  1062. </member>
  1063. <member name="T:Microsoft.Extensions.Logging.NullScope">
  1064. <summary>
  1065. An empty scope without any logic
  1066. </summary>
  1067. </member>
  1068. <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
  1069. <inheritdoc />
  1070. </member>
  1071. <member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
  1072. <summary>
  1073. Pretty print a type name.
  1074. </summary>
  1075. <param name="type">The <see cref="T:System.Type"/>.</param>
  1076. <param name="fullName"><c>true</c> to print a fully qualified name.</param>
  1077. <param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
  1078. <param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
  1079. <param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
  1080. <returns>The pretty printed type name.</returns>
  1081. </member>
  1082. <member name="M:System.Text.ValueStringBuilder.GetPinnableReference">
  1083. <summary>
  1084. Get a pinnable reference to the builder.
  1085. Does not ensure there is a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/>
  1086. This overload is pattern matched in the C# 7.3+ compiler so you can omit
  1087. the explicit method call, and write eg "fixed (char* c = builder)"
  1088. </summary>
  1089. </member>
  1090. <member name="M:System.Text.ValueStringBuilder.GetPinnableReference(System.Boolean)">
  1091. <summary>
  1092. Get a pinnable reference to the builder.
  1093. </summary>
  1094. <param name="terminate">Ensures that the builder has a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/></param>
  1095. </member>
  1096. <member name="P:System.Text.ValueStringBuilder.RawChars">
  1097. <summary>Returns the underlying storage of the builder.</summary>
  1098. </member>
  1099. <member name="M:System.Text.ValueStringBuilder.AsSpan(System.Boolean)">
  1100. <summary>
  1101. Returns a span around the contents of the builder.
  1102. </summary>
  1103. <param name="terminate">Ensures that the builder has a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/></param>
  1104. </member>
  1105. <member name="M:System.Text.ValueStringBuilder.Grow(System.Int32)">
  1106. <summary>
  1107. Resize the internal buffer either by doubling current buffer size or
  1108. by adding <paramref name="additionalCapacityBeyondPos"/> to
  1109. <see cref="F:System.Text.ValueStringBuilder._pos"/> whichever is greater.
  1110. </summary>
  1111. <param name="additionalCapacityBeyondPos">
  1112. Number of chars requested beyond current position.
  1113. </param>
  1114. </member>
  1115. <member name="P:System.SR.UnexpectedNumberOfNamedParameters">
  1116. <summary>The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).</summary>
  1117. </member>
  1118. </members>
  1119. </doc>