Microsoft.Extensions.Logging.Abstractions.xml 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.Abstractions.LogEntry`1">
  8. <summary>Holds the information for a single log entry.</summary>
  9. <typeparam name="TState" />
  10. </member>
  11. <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})">
  12. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.Abstractions.LogEntry`1" /> using the specified log level, category, event Id, state, exception and formatter parameters.</summary>
  13. <param name="logLevel">The log level.</param>
  14. <param name="category">The category name for the log.</param>
  15. <param name="eventId">The log event Id.</param>
  16. <param name="state">The state for which log is being written.</param>
  17. <param name="exception">The log exception.</param>
  18. <param name="formatter">The formatter.</param>
  19. </member>
  20. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Category">
  21. <summary>Gets the log category.</summary>
  22. <returns>A string that represents the log category.</returns>
  23. </member>
  24. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.EventId">
  25. <summary>Gets the log event Id.</summary>
  26. <returns>An <see cref="T:Microsoft.Extensions.Logging.EventId" /> instance.</returns>
  27. </member>
  28. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Exception">
  29. <summary>Gets the log exception.</summary>
  30. <returns>An <see cref="T:System.Exception" /> instance.</returns>
  31. </member>
  32. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Formatter">
  33. <summary>Gets the formatter.</summary>
  34. <returns>The encapsulated method that represents a formatter, which takes a <typeparamref name="TState" /> and a <see cref="T:System.Exception" />, and returns a string.</returns>
  35. </member>
  36. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.LogLevel">
  37. <summary>Gets the log level.</summary>
  38. <returns>A <see cref="T:Microsoft.Extensions.Logging.LogLevel" /> instance.</returns>
  39. </member>
  40. <member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.State">
  41. <summary>Gets the <typeparamref name="TState" />.</summary>
  42. <returns>An object of type <typeparamref name="TState" />.</returns>
  43. </member>
  44. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger">
  45. <summary>Minimalistic logger that does nothing.</summary>
  46. </member>
  47. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.BeginScope``1(``0)">
  48. <summary>Begins a logical operation scope.</summary>
  49. <param name="state">The identifier for the scope.</param>
  50. <typeparam name="TState">The type of the state to begin scope for.</typeparam>
  51. <returns>A disposable object that ends the logical operation scope on dispose.</returns>
  52. </member>
  53. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  54. <summary>Checks if the given <code data-dev-comment-type="paramref">logLevel</code> is enabled.</summary>
  55. <param name="logLevel">level to be checked.</param>
  56. <returns>
  57. <code data-dev-comment-type="langword">true</code> if enabled; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
  58. </member>
  59. <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})">
  60. <summary>Writes a log entry.</summary>
  61. <param name="logLevel">Entry will be written on this level.</param>
  62. <param name="eventId">Id of the event.</param>
  63. <param name="state">The entry to be written. Can be also an object.</param>
  64. <param name="exception">The exception related to this entry.</param>
  65. <param name="formatter">Function to create a <xref data-throw-if-not-resolved="true" uid="System.String"></xref> message of the <code data-dev-comment-type="paramref">state</code> and <code data-dev-comment-type="paramref">exception</code>.</param>
  66. <typeparam name="TState">The type of the object to be written.</typeparam>
  67. </member>
  68. <member name="P:Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance">
  69. <summary>Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" />.</summary>
  70. </member>
  71. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1">
  72. <summary>Minimalistic logger that does nothing.</summary>
  73. <typeparam name="T" />
  74. </member>
  75. <member name="F:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Instance">
  76. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1" />.</summary>
  77. </member>
  78. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.#ctor" />
  79. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.BeginScope``1(``0)">
  80. <summary>Begins a logical operation scope.</summary>
  81. <param name="state">The identifier for the scope.</param>
  82. <typeparam name="TState">The type of the state to begin scope for.</typeparam>
  83. <returns>A disposable object that ends the logical operation scope on dispose.</returns>
  84. </member>
  85. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  86. <summary>Checks if the given <code data-dev-comment-type="paramref">logLevel</code> is enabled.</summary>
  87. <param name="logLevel">level to be checked.</param>
  88. <returns>
  89. <code data-dev-comment-type="langword">true</code> if enabled; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
  90. </member>
  91. <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})">
  92. <summary>Writes a log entry.</summary>
  93. <param name="logLevel">Entry will be written on this level.</param>
  94. <param name="eventId">Id of the event.</param>
  95. <param name="state">The entry to be written. Can be also an object.</param>
  96. <param name="exception">The exception related to this entry.</param>
  97. <param name="formatter">Function to create a <xref data-throw-if-not-resolved="true" uid="System.String"></xref> message of the <code data-dev-comment-type="paramref">state</code> and <code data-dev-comment-type="paramref">exception</code>.</param>
  98. <typeparam name="TState">The type of the object to be written.</typeparam>
  99. </member>
  100. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
  101. <summary>An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" /> used to create instance of
  102. <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" /> that logs nothing.</summary>
  103. </member>
  104. <member name="F:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Instance">
  105. <summary>Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory" />.</summary>
  106. </member>
  107. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.#ctor">
  108. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory" /> instance.</summary>
  109. </member>
  110. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  111. <summary>Adds an <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILoggerProvider"></xref> to the logging system.</summary>
  112. <param name="provider">The <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILoggerProvider"></xref>.</param>
  113. </member>
  114. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.CreateLogger(System.String)">
  115. <summary>Creates a new <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILogger"></xref> instance.</summary>
  116. <param name="name" />
  117. <returns>A new <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILogger"></xref> instance.</returns>
  118. </member>
  119. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Dispose">
  120. <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
  121. </member>
  122. <member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
  123. <summary>Provider for the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger" />.</summary>
  124. </member>
  125. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.CreateLogger(System.String)">
  126. <summary>Creates a new <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILogger"></xref> instance.</summary>
  127. <param name="categoryName">The category name for messages produced by the logger.</param>
  128. <returns>The instance of <xref data-throw-if-not-resolved="true" uid="Microsoft.Extensions.Logging.ILogger"></xref> that was created.</returns>
  129. </member>
  130. <member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Dispose">
  131. <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
  132. </member>
  133. <member name="P:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Instance">
  134. <summary>Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider" />.</summary>
  135. </member>
  136. <member name="T:Microsoft.Extensions.Logging.EventId">
  137. <summary>Identifies a logging event. The primary identifier is the "Id" property, with the "Name" property providing a short description of this type of event.</summary>
  138. </member>
  139. <member name="M:Microsoft.Extensions.Logging.EventId.#ctor(System.Int32,System.String)">
  140. <summary>Initializes an instance of the <see cref="T:Microsoft.Extensions.Logging.EventId" /> struct.</summary>
  141. <param name="id">The numeric identifier for this event.</param>
  142. <param name="name">The name of this event.</param>
  143. </member>
  144. <member name="M:Microsoft.Extensions.Logging.EventId.Equals(Microsoft.Extensions.Logging.EventId)">
  145. <summary>Indicates whether the current object is equal to another object of the same type. Two events are equal if they have the same id.</summary>
  146. <param name="other">An object to compare with this object.</param>
  147. <returns>
  148. <see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
  149. </member>
  150. <member name="M:Microsoft.Extensions.Logging.EventId.Equals(System.Object)">
  151. <summary>Indicates whether this instance and a specified object are equal.</summary>
  152. <param name="obj">The object to compare with the current instance.</param>
  153. <returns>
  154. <code data-dev-comment-type="langword">true</code> if <code data-dev-comment-type="paramref">obj</code> and this instance are the same type and represent the same value; otherwise, <code data-dev-comment-type="langword">false</code>.</returns>
  155. </member>
  156. <member name="M:Microsoft.Extensions.Logging.EventId.GetHashCode">
  157. <summary>Returns the hash code for this instance.</summary>
  158. <returns>A 32-bit signed integer that is the hash code for this instance.</returns>
  159. </member>
  160. <member name="M:Microsoft.Extensions.Logging.EventId.op_Equality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
  161. <summary>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.</summary>
  162. <param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
  163. <param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
  164. <returns>
  165. <see langword="true" /> if the objects are equal.</returns>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Logging.EventId.op_Implicit(System.Int32)~Microsoft.Extensions.Logging.EventId">
  168. <summary>Implicitly creates an EventId from the given <see cref="T:System.Int32" />.</summary>
  169. <param name="i">The <see cref="T:System.Int32" /> to convert to an EventId.</param>
  170. </member>
  171. <member name="M:Microsoft.Extensions.Logging.EventId.op_Inequality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
  172. <summary>Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId" /> instances have different values.</summary>
  173. <param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
  174. <param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId" />.</param>
  175. <returns>
  176. <see langword="true" /> if the objects are not equal.</returns>
  177. </member>
  178. <member name="M:Microsoft.Extensions.Logging.EventId.ToString">
  179. <summary>Returns the fully qualified type name of this instance.</summary>
  180. <returns>The fully qualified type name.</returns>
  181. </member>
  182. <member name="P:Microsoft.Extensions.Logging.EventId.Id">
  183. <summary>Gets the numeric identifier for this event.</summary>
  184. </member>
  185. <member name="P:Microsoft.Extensions.Logging.EventId.Name">
  186. <summary>Gets the name of this event.</summary>
  187. </member>
  188. <member name="T:Microsoft.Extensions.Logging.IExternalScopeProvider">
  189. <summary>Represents a storage of common scope data.</summary>
  190. </member>
  191. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  192. <summary>Executes callback for each currently active scope objects in order of creation.
  193. All callbacks are guaranteed to be called inline from this method.</summary>
  194. <param name="callback">The callback to be executed for every scope object.</param>
  195. <param name="state">The state object to be passed into the callback.</param>
  196. <typeparam name="TState">The type of state to accept.</typeparam>
  197. </member>
  198. <member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.Push(System.Object)">
  199. <summary>Adds scope object to the list.</summary>
  200. <param name="state">The scope object.</param>
  201. <returns>The <see cref="T:System.IDisposable" /> token that removes scope on dispose.</returns>
  202. </member>
  203. <member name="T:Microsoft.Extensions.Logging.ILogger">
  204. <summary>Represents a type used to perform logging.</summary>
  205. </member>
  206. <member name="M:Microsoft.Extensions.Logging.ILogger.BeginScope``1(``0)">
  207. <summary>Begins a logical operation scope.</summary>
  208. <param name="state">The identifier for the scope.</param>
  209. <typeparam name="TState">The type of the state to begin scope for.</typeparam>
  210. <returns>A disposable object that ends the logical operation scope on dispose.</returns>
  211. </member>
  212. <member name="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  213. <summary>Checks if the given <paramref name="logLevel" /> is enabled.</summary>
  214. <param name="logLevel">level to be checked.</param>
  215. <returns>
  216. <see langword="true" /> if enabled; <see langword="false" /> otherwise.</returns>
  217. </member>
  218. <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})">
  219. <summary>Writes a log entry.</summary>
  220. <param name="logLevel">Entry will be written on this level.</param>
  221. <param name="eventId">Id of the event.</param>
  222. <param name="state">The entry to be written. Can be also an object.</param>
  223. <param name="exception">The exception related to this entry.</param>
  224. <param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
  225. <typeparam name="TState">The type of the object to be written.</typeparam>
  226. </member>
  227. <member name="T:Microsoft.Extensions.Logging.ILogger`1">
  228. <summary>A generic interface for logging where the category name is derived from the specified
  229. <typeparamref name="TCategoryName" /> type name.
  230. Generally used to enable activation of a named <see cref="T:Microsoft.Extensions.Logging.ILogger" /> from dependency injection.</summary>
  231. <typeparam name="TCategoryName">The type whose name is used for the logger category name.</typeparam>
  232. </member>
  233. <member name="T:Microsoft.Extensions.Logging.ILoggerFactory">
  234. <summary>Represents a type used to configure the logging system and create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> from
  235. the registered <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />s.</summary>
  236. </member>
  237. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
  238. <summary>Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> to the logging system.</summary>
  239. <param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" />.</param>
  240. </member>
  241. <member name="M:Microsoft.Extensions.Logging.ILoggerFactory.CreateLogger(System.String)">
  242. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
  243. <param name="categoryName">The category name for messages produced by the logger.</param>
  244. <returns>A new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</returns>
  245. </member>
  246. <member name="T:Microsoft.Extensions.Logging.ILoggerProvider">
  247. <summary>Represents a type that can create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger" />.</summary>
  248. </member>
  249. <member name="M:Microsoft.Extensions.Logging.ILoggerProvider.CreateLogger(System.String)">
  250. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance.</summary>
  251. <param name="categoryName">The category name for messages produced by the logger.</param>
  252. <returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
  253. </member>
  254. <member name="T:Microsoft.Extensions.Logging.ISupportExternalScope">
  255. <summary>Represents a <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider" /> that is able to consume external scope information.</summary>
  256. </member>
  257. <member name="M:Microsoft.Extensions.Logging.ISupportExternalScope.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  258. <summary>Sets external scope information source for logger provider.</summary>
  259. <param name="scopeProvider">The provider of scope data.</param>
  260. </member>
  261. <member name="T:Microsoft.Extensions.Logging.LogDefineOptions">
  262. <summary>Specifies options for <see cref="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)" /> and its overloads.</summary>
  263. </member>
  264. <member name="M:Microsoft.Extensions.Logging.LogDefineOptions.#ctor" />
  265. <member name="P:Microsoft.Extensions.Logging.LogDefineOptions.SkipEnabledCheck">
  266. <summary>Gets or sets the flag to skip the <see langword="IsEnabled" /> check for the logging method.</summary>
  267. </member>
  268. <member name="T:Microsoft.Extensions.Logging.Logger`1">
  269. <summary>Delegates to a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance using the full name of the given type, created by the
  270. provided <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory" />.</summary>
  271. <typeparam name="T">The type.</typeparam>
  272. </member>
  273. <member name="M:Microsoft.Extensions.Logging.Logger`1.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
  274. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.Logger`1" />.</summary>
  275. <param name="factory">The factory.</param>
  276. </member>
  277. <member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#BeginScope``1(``0)">
  278. <summary>Begins a logical operation scope.</summary>
  279. <param name="state">The identifier for the scope.</param>
  280. <typeparam name="TState">The type of the state to begin scope for.</typeparam>
  281. <returns>A disposable object that ends the logical operation scope on dispose.</returns>
  282. </member>
  283. <member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  284. <summary>Checks if the given <code data-dev-comment-type="paramref">logLevel</code> is enabled.</summary>
  285. <param name="logLevel">level to be checked.</param>
  286. <returns>
  287. <code data-dev-comment-type="langword">true</code> if enabled; <code data-dev-comment-type="langword">false</code> otherwise.</returns>
  288. </member>
  289. <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})">
  290. <summary>Writes a log entry.</summary>
  291. <param name="logLevel">Entry will be written on this level.</param>
  292. <param name="eventId">Id of the event.</param>
  293. <param name="state">The entry to be written. Can be also an object.</param>
  294. <param name="exception">The exception related to this entry.</param>
  295. <param name="formatter">Function to create a <xref data-throw-if-not-resolved="true" uid="System.String"></xref> message of the <code data-dev-comment-type="paramref">state</code> and <code data-dev-comment-type="paramref">exception</code>.</param>
  296. <typeparam name="TState">The type of the object to be written.</typeparam>
  297. </member>
  298. <member name="T:Microsoft.Extensions.Logging.LoggerExtensions">
  299. <summary>ILogger extension methods for common scenarios.</summary>
  300. </member>
  301. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.BeginScope(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  302. <summary>Formats the message and creates a scope.</summary>
  303. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to create the scope in.</param>
  304. <param name="messageFormat">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  305. <param name="args">An object array that contains zero or more objects to format.</param>
  306. <returns>A disposable scope object. Can be null.</returns>
  307. </member>
  308. <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[])">
  309. <summary>Formats and writes a log message at the specified log level.</summary>
  310. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  311. <param name="logLevel">Entry will be written on this level.</param>
  312. <param name="eventId">The event id associated with the log.</param>
  313. <param name="exception">The exception to log.</param>
  314. <param name="message">Format string of the log message.</param>
  315. <param name="args">An object array that contains zero or more objects to format.</param>
  316. </member>
  317. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  318. <summary>Formats and writes a log message at the specified log level.</summary>
  319. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  320. <param name="logLevel">Entry will be written on this level.</param>
  321. <param name="eventId">The event id associated with the log.</param>
  322. <param name="message">Format string of the log message.</param>
  323. <param name="args">An object array that contains zero or more objects to format.</param>
  324. </member>
  325. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.Exception,System.String,System.Object[])">
  326. <summary>Formats and writes a log message at the specified log level.</summary>
  327. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  328. <param name="logLevel">Entry will be written on this level.</param>
  329. <param name="exception">The exception to log.</param>
  330. <param name="message">Format string of the log message.</param>
  331. <param name="args">An object array that contains zero or more objects to format.</param>
  332. </member>
  333. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.String,System.Object[])">
  334. <summary>Formats and writes a log message at the specified log level.</summary>
  335. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  336. <param name="logLevel">Entry will be written on this level.</param>
  337. <param name="message">Format string of the log message.</param>
  338. <param name="args">An object array that contains zero or more objects to format.</param>
  339. </member>
  340. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  341. <summary>Formats and writes a critical log message.</summary>
  342. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  343. <param name="eventId">The event id associated with the log.</param>
  344. <param name="exception">The exception to log.</param>
  345. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  346. <param name="args">An object array that contains zero or more objects to format.</param>
  347. </member>
  348. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  349. <summary>Formats and writes a critical log message.</summary>
  350. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  351. <param name="eventId">The event id associated with the log.</param>
  352. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  353. <param name="args">An object array that contains zero or more objects to format.</param>
  354. </member>
  355. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  356. <summary>Formats and writes a critical log message.</summary>
  357. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  358. <param name="exception">The exception to log.</param>
  359. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  360. <param name="args">An object array that contains zero or more objects to format.</param>
  361. </member>
  362. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  363. <summary>Formats and writes a critical log message.</summary>
  364. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  365. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  366. <param name="args">An object array that contains zero or more objects to format.</param>
  367. </member>
  368. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  369. <summary>Formats and writes a debug log message.</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. </member>
  376. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  377. <summary>Formats and writes a debug log message.</summary>
  378. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  379. <param name="eventId">The event id associated with the log.</param>
  380. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  381. <param name="args">An object array that contains zero or more objects to format.</param>
  382. </member>
  383. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  384. <summary>Formats and writes a debug log message.</summary>
  385. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  386. <param name="exception">The exception to log.</param>
  387. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  388. <param name="args">An object array that contains zero or more objects to format.</param>
  389. </member>
  390. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  391. <summary>Formats and writes a debug log message.</summary>
  392. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</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. </member>
  396. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  397. <summary>Formats and writes an error log message.</summary>
  398. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  399. <param name="eventId">The event id associated with the log.</param>
  400. <param name="exception">The exception to log.</param>
  401. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  402. <param name="args">An object array that contains zero or more objects to format.</param>
  403. </member>
  404. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  405. <summary>Formats and writes an error log message.</summary>
  406. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  407. <param name="eventId">The event id associated with the log.</param>
  408. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  409. <param name="args">An object array that contains zero or more objects to format.</param>
  410. </member>
  411. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  412. <summary>Formats and writes an error log message.</summary>
  413. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  414. <param name="exception">The exception to log.</param>
  415. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  416. <param name="args">An object array that contains zero or more objects to format.</param>
  417. </member>
  418. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  419. <summary>Formats and writes an error log message.</summary>
  420. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  421. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  422. <param name="args">An object array that contains zero or more objects to format.</param>
  423. </member>
  424. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  425. <summary>Formats and writes an informational log message.</summary>
  426. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  427. <param name="eventId">The event id associated with the log.</param>
  428. <param name="exception">The exception to log.</param>
  429. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  430. <param name="args">An object array that contains zero or more objects to format.</param>
  431. </member>
  432. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  433. <summary>Formats and writes an informational log message.</summary>
  434. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  435. <param name="eventId">The event id associated with the log.</param>
  436. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  437. <param name="args">An object array that contains zero or more objects to format.</param>
  438. </member>
  439. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  440. <summary>Formats and writes an informational log message.</summary>
  441. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  442. <param name="exception">The exception to log.</param>
  443. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  444. <param name="args">An object array that contains zero or more objects to format.</param>
  445. </member>
  446. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  447. <summary>Formats and writes an informational log message.</summary>
  448. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  449. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  450. <param name="args">An object array that contains zero or more objects to format.</param>
  451. </member>
  452. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  453. <summary>Formats and writes a trace log message.</summary>
  454. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  455. <param name="eventId">The event id associated with the log.</param>
  456. <param name="exception">The exception to log.</param>
  457. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  458. <param name="args">An object array that contains zero or more objects to format.</param>
  459. </member>
  460. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  461. <summary>Formats and writes a trace log message.</summary>
  462. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  463. <param name="eventId">The event id associated with the log.</param>
  464. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  465. <param name="args">An object array that contains zero or more objects to format.</param>
  466. </member>
  467. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  468. <summary>Formats and writes a trace log message.</summary>
  469. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  470. <param name="exception">The exception to log.</param>
  471. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  472. <param name="args">An object array that contains zero or more objects to format.</param>
  473. </member>
  474. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  475. <summary>Formats and writes a trace log message.</summary>
  476. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  477. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  478. <param name="args">An object array that contains zero or more objects to format.</param>
  479. </member>
  480. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
  481. <summary>Formats and writes a warning log message.</summary>
  482. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  483. <param name="eventId">The event id associated with the log.</param>
  484. <param name="exception">The exception to log.</param>
  485. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  486. <param name="args">An object array that contains zero or more objects to format.</param>
  487. </member>
  488. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
  489. <summary>Formats and writes a warning log message.</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="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  493. <param name="args">An object array that contains zero or more objects to format.</param>
  494. </member>
  495. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
  496. <summary>Formats and writes a warning log message.</summary>
  497. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  498. <param name="exception">The exception to log.</param>
  499. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  500. <param name="args">An object array that contains zero or more objects to format.</param>
  501. </member>
  502. <member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
  503. <summary>Formats and writes a warning log message.</summary>
  504. <param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> to write to.</param>
  505. <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
  506. <param name="args">An object array that contains zero or more objects to format.</param>
  507. </member>
  508. <member name="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider">
  509. <summary>Default implementation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider" />.</summary>
  510. </member>
  511. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.#ctor">
  512. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider" />.</summary>
  513. </member>
  514. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
  515. <summary>Executes callback for each currently active scope objects in order of creation.
  516. All callbacks are guaranteed to be called inline from this method.</summary>
  517. <param name="callback">The callback to be executed for every scope object.</param>
  518. <param name="state">The state object to be passed into the callback.</param>
  519. <typeparam name="TState">The type of state to accept.</typeparam>
  520. </member>
  521. <member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.Push(System.Object)">
  522. <summary>Adds scope object to the list.</summary>
  523. <param name="state">The scope object.</param>
  524. <returns>The <xref data-throw-if-not-resolved="true" uid="System.IDisposable"></xref> token that removes scope on dispose.</returns>
  525. </member>
  526. <member name="T:Microsoft.Extensions.Logging.LoggerFactoryExtensions">
  527. <summary>ILoggerFactory extension methods for common scenarios.</summary>
  528. </member>
  529. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger(Microsoft.Extensions.Logging.ILoggerFactory,System.Type)">
  530. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance using the full name of the given <paramref name="type" />.</summary>
  531. <param name="factory">The factory.</param>
  532. <param name="type">The type.</param>
  533. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
  534. </member>
  535. <member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger``1(Microsoft.Extensions.Logging.ILoggerFactory)">
  536. <summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance using the full name of the given type.</summary>
  537. <param name="factory">The factory.</param>
  538. <typeparam name="T">The type.</typeparam>
  539. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
  540. </member>
  541. <member name="T:Microsoft.Extensions.Logging.LoggerMessage">
  542. <summary>Creates delegates which can be later cached to log messages in a performant way.</summary>
  543. </member>
  544. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  545. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  546. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  547. <param name="eventId">The event ID.</param>
  548. <param name="formatString">The named format string.</param>
  549. <returns>A delegate which when invoked creates a log message.</returns>
  550. </member>
  551. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  552. <summary>Creates a delegate that can be invoked to log a message.</summary>
  553. <param name="logLevel">The logging level.</param>
  554. <param name="eventId">The event ID.</param>
  555. <param name="formatString">The named format string.</param>
  556. <param name="options">The log define options.</param>
  557. <returns>A delegate that, when invoked, creates a log message.</returns>
  558. </member>
  559. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  560. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  561. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  562. <param name="eventId">The event ID.</param>
  563. <param name="formatString">The named format string.</param>
  564. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  565. <returns>A delegate which when invoked creates a log message.</returns>
  566. </member>
  567. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  568. <summary>Creates a delegate that can be invoked to log a message.</summary>
  569. <param name="logLevel">The logging level.</param>
  570. <param name="eventId">The event ID.</param>
  571. <param name="formatString">The named format string.</param>
  572. <param name="options">The log define options.</param>
  573. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  574. <returns>A delegate that, when invoked, creates a log message.</returns>
  575. </member>
  576. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  577. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  578. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  579. <param name="eventId">The event ID.</param>
  580. <param name="formatString">The named format string.</param>
  581. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  582. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  583. <returns>A delegate which when invoked creates a log message.</returns>
  584. </member>
  585. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  586. <summary>Creates a delegate that can be invoked to log a message.</summary>
  587. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  588. <param name="eventId">The event ID.</param>
  589. <param name="formatString">The named format string.</param>
  590. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions" />.</param>
  591. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  592. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  593. <returns>A delegate that, when invoked, creates a log message.</returns>
  594. </member>
  595. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  596. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  597. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  598. <param name="eventId">The event ID.</param>
  599. <param name="formatString">The named format string.</param>
  600. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  601. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  602. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  603. <returns>A delegate which when invoked creates a log message.</returns>
  604. </member>
  605. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  606. <summary>Creates a delegate that can be invoked to log a message.</summary>
  607. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  608. <param name="eventId">The event ID.</param>
  609. <param name="formatString">The named format string.</param>
  610. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions" />.</param>
  611. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  612. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  613. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  614. <returns>A delegate that, when invoked, creates a log message.</returns>
  615. </member>
  616. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  617. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  618. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  619. <param name="eventId">The event ID.</param>
  620. <param name="formatString">The named format string.</param>
  621. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  622. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  623. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  624. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  625. <returns>A delegate which when invoked creates a log message.</returns>
  626. </member>
  627. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  628. <summary>Creates a delegate that can be invoked to log a message.</summary>
  629. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  630. <param name="eventId">The event ID.</param>
  631. <param name="formatString">The named format string.</param>
  632. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions" />.</param>
  633. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  634. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  635. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  636. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  637. <returns>A delegate that, when invoked, creates a log message.</returns>
  638. </member>
  639. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  640. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  641. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  642. <param name="eventId">The event ID.</param>
  643. <param name="formatString">The named format string.</param>
  644. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  645. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  646. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  647. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  648. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  649. <returns>A delegate which when invoked creates a log message.</returns>
  650. </member>
  651. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  652. <summary>Creates a delegate that can be invoked to log a message.</summary>
  653. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  654. <param name="eventId">The event ID.</param>
  655. <param name="formatString">The named format string.</param>
  656. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions" />.</param>
  657. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  658. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  659. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  660. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  661. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  662. <returns>A delegate that, when invoked, creates a log message.</returns>
  663. </member>
  664. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
  665. <summary>Creates a delegate which can be invoked for logging a message.</summary>
  666. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  667. <param name="eventId">The event ID.</param>
  668. <param name="formatString">The named format string.</param>
  669. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  670. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  671. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  672. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  673. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  674. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  675. <returns>A delegate which when invoked creates a log message.</returns>
  676. </member>
  677. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
  678. <summary>Creates a delegate that can be invoked to log a message.</summary>
  679. <param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel" />.</param>
  680. <param name="eventId">The event ID.</param>
  681. <param name="formatString">The named format string.</param>
  682. <param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions" />.</param>
  683. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  684. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  685. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  686. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  687. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  688. <typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
  689. <returns>A delegate that, when invoked, creates a log message.</returns>
  690. </member>
  691. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope(System.String)">
  692. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  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``1(System.String)">
  697. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  698. <param name="formatString">The named format string.</param>
  699. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  700. <returns>A delegate which when invoked creates a log scope.</returns>
  701. </member>
  702. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``2(System.String)">
  703. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  704. <param name="formatString">The named format string.</param>
  705. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  706. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  707. <returns>A delegate which when invoked creates a log scope.</returns>
  708. </member>
  709. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``3(System.String)">
  710. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  711. <param name="formatString">The named format string.</param>
  712. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  713. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  714. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  715. <returns>A delegate which when invoked creates a log scope.</returns>
  716. </member>
  717. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``4(System.String)">
  718. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  719. <param name="formatString">The named format string.</param>
  720. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  721. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  722. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  723. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  724. <returns>A delegate which when invoked creates a log scope.</returns>
  725. </member>
  726. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``5(System.String)">
  727. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  728. <param name="formatString">The named format string.</param>
  729. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  730. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  731. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  732. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  733. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  734. <returns>A delegate which when invoked creates a log scope.</returns>
  735. </member>
  736. <member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``6(System.String)">
  737. <summary>Creates a delegate which can be invoked to create a log scope.</summary>
  738. <param name="formatString">The named format string.</param>
  739. <typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
  740. <typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
  741. <typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
  742. <typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
  743. <typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
  744. <typeparam name="T6">The type of the sisxth parameter passed to the named format string.</typeparam>
  745. <returns>A delegate which when invoked creates a log scope.</returns>
  746. </member>
  747. <member name="T:Microsoft.Extensions.Logging.LoggerMessageAttribute">
  748. <summary>Provides information to guide the production of a strongly-typed logging method.</summary>
  749. </member>
  750. <member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor">
  751. <summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute" /> class which is used to guide the production of a strongly-typed logging method.</summary>
  752. </member>
  753. <member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor(System.Int32,Microsoft.Extensions.Logging.LogLevel,System.String)">
  754. <summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute" /> class, which is used to guide the production of a strongly typed logging method.</summary>
  755. <param name="eventId">The log event ID.</param>
  756. <param name="level">The log level.</param>
  757. <param name="message">The format string of the log message.</param>
  758. </member>
  759. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventId">
  760. <summary>Gets the logging event id for the logging method.</summary>
  761. </member>
  762. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventName">
  763. <summary>Gets or sets the logging event name for the logging method.</summary>
  764. </member>
  765. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Level">
  766. <summary>Gets the logging level for the logging method.</summary>
  767. </member>
  768. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Message">
  769. <summary>Gets the message text for the logging method.</summary>
  770. </member>
  771. <member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.SkipEnabledCheck">
  772. <summary>Gets or sets the flag to skip the <see langword="IsEnabled" /> check for the logging method.</summary>
  773. </member>
  774. <member name="T:Microsoft.Extensions.Logging.LogLevel">
  775. <summary>Defines logging severity levels.</summary>
  776. </member>
  777. <member name="F:Microsoft.Extensions.Logging.LogLevel.Critical">
  778. <summary>Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
  779. immediate attention.</summary>
  780. </member>
  781. <member name="F:Microsoft.Extensions.Logging.LogLevel.Debug">
  782. <summary>Logs that are used for interactive investigation during development. These logs should primarily contain
  783. information useful for debugging and have no long-term value.</summary>
  784. </member>
  785. <member name="F:Microsoft.Extensions.Logging.LogLevel.Error">
  786. <summary>Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
  787. failure in the current activity, not an application-wide failure.</summary>
  788. </member>
  789. <member name="F:Microsoft.Extensions.Logging.LogLevel.Information">
  790. <summary>Logs that track the general flow of the application. These logs should have long-term value.</summary>
  791. </member>
  792. <member name="F:Microsoft.Extensions.Logging.LogLevel.None">
  793. <summary>Not used for writing log messages. Specifies that a logging category should not write any messages.</summary>
  794. </member>
  795. <member name="F:Microsoft.Extensions.Logging.LogLevel.Trace">
  796. <summary>Logs that contain the most detailed messages. These messages may contain sensitive application data.
  797. These messages are disabled by default and should never be enabled in a production environment.</summary>
  798. </member>
  799. <member name="F:Microsoft.Extensions.Logging.LogLevel.Warning">
  800. <summary>Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
  801. application execution to stop.</summary>
  802. </member>
  803. </members>
  804. </doc>