Microsoft.Extensions.Logging.EventLog.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.EventLog</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.EventLoggerFactoryExtensions">
  8. <summary>
  9. Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Logging.EventLoggerFactoryExtensions.AddEventLog(Microsoft.Extensions.Logging.ILoggingBuilder)">
  13. <summary>
  14. Adds an event logger named 'EventLog' to the factory.
  15. </summary>
  16. <param name="builder">The extension method argument.</param>
  17. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
  18. </member>
  19. <member name="M:Microsoft.Extensions.Logging.EventLoggerFactoryExtensions.AddEventLog(Microsoft.Extensions.Logging.ILoggingBuilder,Microsoft.Extensions.Logging.EventLog.EventLogSettings)">
  20. <summary>
  21. Adds an event logger. Use <paramref name="settings"/> to enable logging for specific <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>s.
  22. </summary>
  23. <param name="builder">The extension method argument.</param>
  24. <param name="settings">The <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogSettings"/>.</param>
  25. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
  26. </member>
  27. <member name="M:Microsoft.Extensions.Logging.EventLoggerFactoryExtensions.AddEventLog(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.EventLog.EventLogSettings})">
  28. <summary>
  29. Adds an event logger. Use <paramref name="configure"/> to enable logging for specific <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>s.
  30. </summary>
  31. <param name="builder">The extension method argument.</param>
  32. <param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogSettings"/>.</param>
  33. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
  34. </member>
  35. <member name="T:Microsoft.Extensions.Logging.EventLog.EventLogLogger">
  36. <summary>
  37. A logger that writes messages to Windows Event Log.
  38. </summary>
  39. </member>
  40. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLogger.#ctor(System.String,Microsoft.Extensions.Logging.EventLog.EventLogSettings,Microsoft.Extensions.Logging.IExternalScopeProvider)">
  41. <summary>
  42. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLogger"/> class.
  43. </summary>
  44. <param name="name">The name of the logger.</param>
  45. <param name="settings">The <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogSettings"/>.</param>
  46. <param name="externalScopeProvider">The <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>.</param>
  47. </member>
  48. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLogger.BeginScope``1(``0)">
  49. <inheritdoc />
  50. </member>
  51. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
  52. <inheritdoc />
  53. </member>
  54. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
  55. <inheritdoc />
  56. </member>
  57. <member name="T:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider">
  58. <summary>
  59. The provider for the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLogger"/>.
  60. </summary>
  61. </member>
  62. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.#ctor">
  63. <summary>
  64. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider"/> class.
  65. </summary>
  66. </member>
  67. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.#ctor(Microsoft.Extensions.Logging.EventLog.EventLogSettings)">
  68. <summary>
  69. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider"/> class.
  70. </summary>
  71. <param name="settings">The <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogSettings"/>.</param>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Logging.EventLog.EventLogSettings})">
  74. <summary>
  75. Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider"/> class.
  76. </summary>
  77. <param name="options">The <see cref="T:Microsoft.Extensions.Options.IOptions`1"/>.</param>
  78. </member>
  79. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.CreateLogger(System.String)">
  80. <inheritdoc />
  81. </member>
  82. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.Dispose">
  83. <inheritdoc />
  84. </member>
  85. <member name="M:Microsoft.Extensions.Logging.EventLog.EventLogLoggerProvider.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
  86. <inheritdoc />
  87. </member>
  88. <member name="T:Microsoft.Extensions.Logging.EventLog.EventLogSettings">
  89. <summary>
  90. Settings for <see cref="T:Microsoft.Extensions.Logging.EventLog.EventLogLogger"/>.
  91. </summary>
  92. </member>
  93. <member name="P:Microsoft.Extensions.Logging.EventLog.EventLogSettings.LogName">
  94. <summary>
  95. Name of the event log. If <c>null</c> or not specified, "Application" is the default.
  96. </summary>
  97. </member>
  98. <member name="P:Microsoft.Extensions.Logging.EventLog.EventLogSettings.SourceName">
  99. <summary>
  100. Name of the event log source. If <c>null</c> or not specified, ".NET Runtime" is the default.
  101. </summary>
  102. </member>
  103. <member name="P:Microsoft.Extensions.Logging.EventLog.EventLogSettings.MachineName">
  104. <summary>
  105. Name of the machine having the event log. If <c>null</c> or not specified, local machine is the default.
  106. </summary>
  107. </member>
  108. <member name="P:Microsoft.Extensions.Logging.EventLog.EventLogSettings.Filter">
  109. <summary>
  110. The function used to filter events based on the log level.
  111. </summary>
  112. </member>
  113. <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
  114. <summary>
  115. Scope provider that does nothing.
  116. </summary>
  117. </member>
  118. <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
  119. <summary>
  120. Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
  121. </summary>
  122. </member>
  123. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
  124. <inheritdoc />
  125. </member>
  126. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
  127. <inheritdoc />
  128. </member>
  129. <member name="T:Microsoft.Extensions.Logging.NullScope">
  130. <summary>
  131. An empty scope without any logic
  132. </summary>
  133. </member>
  134. <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
  135. <inheritdoc />
  136. </member>
  137. <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
  138. <summary>
  139. Base type for all platform-specific API attributes.
  140. </summary>
  141. </member>
  142. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  143. <summary>
  144. Records the platform that the project targeted.
  145. </summary>
  146. </member>
  147. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  148. <summary>
  149. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  150. applied to indicate support on multiple operating systems.
  151. </summary>
  152. <remarks>
  153. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  154. or use guards to prevent calls to APIs on unsupported operating systems.
  155. A given platform should only be specified once.
  156. </remarks>
  157. </member>
  158. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  159. <summary>
  160. Marks APIs that were removed in a given operating system version.
  161. </summary>
  162. <remarks>
  163. Primarily used by OS bindings to indicate APIs that are only available in
  164. earlier versions.
  165. </remarks>
  166. </member>
  167. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  168. <summary>
  169. Annotates a custom guard field, property or method with a supported platform name and optional version.
  170. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  171. </summary>
  172. <remarks>
  173. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  174. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  175. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  176. </remarks>
  177. </member>
  178. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  179. <summary>
  180. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  181. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  182. </summary>
  183. <remarks>
  184. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  185. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  186. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  187. </remarks>
  188. </member>
  189. </members>
  190. </doc>