Microsoft.Extensions.Logging.EventSource.xml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Logging.EventSource</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger">
  8. <summary>
  9. A logger that writes messages to EventSource instance.
  10. </summary>
  11. <remarks>
  12. On Windows platforms EventSource will deliver messages using Event Tracing for Windows (ETW) events.
  13. On Linux EventSource will use LTTng (http://lttng.org) to deliver messages.
  14. </remarks>
  15. </member>
  16. <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.ActivityScope">
  17. <summary>
  18. ActivityScope is just a IDisposable that knows how to send the ActivityStop event when it is
  19. desposed. It is part of the BeginScope() support.
  20. </summary>
  21. </member>
  22. <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetExceptionInfo(System.Exception)">
  23. <summary>
  24. 'serializes' a given exception into an ExceptionInfo (that EventSource knows how to serialize)
  25. </summary>
  26. <param name="exception">The exception to get information for.</param>
  27. <returns>ExceptionInfo object represending a .NET Exception</returns>
  28. <remarks>ETW does not support a concept of a null value. So we use an un-initialized object if there is no exception in the event data.</remarks>
  29. </member>
  30. <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetProperties(System.Object)">
  31. <summary>
  32. Converts an ILogger state object into a set of key-value pairs (That can be send to a EventSource)
  33. </summary>
  34. </member>
  35. <member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider">
  36. <summary>
  37. The provider for the <see cref="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger"/>.
  38. </summary>
  39. </member>
  40. <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.CreateLogger(System.String)">
  41. <inheritdoc />
  42. </member>
  43. <member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.Dispose">
  44. <inheritdoc />
  45. </member>
  46. <member name="T:Microsoft.Extensions.Logging.EventSource.ExceptionInfo">
  47. <summary>
  48. Represents information about exceptions that is captured by EventSourceLogger
  49. </summary>
  50. </member>
  51. <member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource">
  52. <summary>
  53. The LoggingEventSource is the bridge from all ILogger based logging to EventSource/EventListener logging.
  54. You turn this logging on by enabling the EventSource called
  55. Microsoft-Extensions-Logging
  56. When you enabled the EventSource, the EventLevel you set is translated in the obvious way to the level
  57. associated with the ILogger (thus Debug = verbose, Informational = Informational ... Critical == Critical)
  58. This allows you to filter by event level in a straightforward way.
  59. For finer control you can specify a EventSource Argument called
  60. FilterSpecs
  61. The FilterSpecs argument is a semicolon separated list of specifications. Where each specification is
  62. SPEC = // empty spec, same as *
  63. | NAME // Just a name the level is the default level
  64. | NAME : LEVEL // specifies level for a particular logger (can have a * suffix).
  65. When "UseAppFilters" is specified in the FilterSpecs, it avoids disabling all categories which happens by default otherwise.
  66. Where Name is the name of a ILoggger (case matters), Name can have a * which acts as a wildcard
  67. AS A SUFFIX. Thus Net* will match any loggers that start with the 'Net'.
  68. The LEVEL is a number or a LogLevel string. 0=Trace, 1=Debug, 2=Information, 3=Warning, 4=Error, Critical=5
  69. This specifies the level for the associated pattern. If the number is not specified, (first form
  70. of the specification) it is the default level for the EventSource.
  71. First match is used if a particular name matches more than one pattern.
  72. In addition the level and FilterSpec argument, you can also set EventSource Keywords. See the Keywords
  73. definition below, but basically you get to decide if you wish to have
  74. * Keywords.Message - You get the event with the data in parsed form.
  75. * Keywords.JsonMessage - you get an event with the data in parse form but as a JSON blob (not broken up by argument ...)
  76. * Keywords.FormattedMessage - you get an event with the data formatted as a string
  77. It is expected that you will turn only one of these keywords on at a time, but you can turn them all on (and get
  78. the same data logged three different ways.
  79. Example Usage
  80. This example shows how to use an EventListener to get ILogging information
  81. class MyEventListener : EventListener {
  82. protected override void OnEventSourceCreated(EventSource eventSource) {
  83. if (eventSource.Name == "Microsoft-Extensions-Logging") {
  84. // initialize a string, string dictionary of arguments to pass to the EventSource.
  85. // Turn on loggers matching App* to Information, everything else (*) is the default level (which is EventLevel.Error)
  86. var args = new Dictionary&lt;string, string&gt;() { { "FilterSpecs", "App*:Information;*" } };
  87. // Set the default level (verbosity) to Error, and only ask for the formatted messages in this case.
  88. EnableEvents(eventSource, EventLevel.Error, LoggingEventSource.Keywords.FormattedMessage, args);
  89. }
  90. }
  91. protected override void OnEventWritten(EventWrittenEventArgs eventData) {
  92. // Look for the formatted message event, which has the following argument layout (as defined in the LoggingEventSource.
  93. // FormattedMessage(LogLevel Level, int FactoryID, string LoggerName, string EventId, string FormattedMessage);
  94. if (eventData.EventName == "FormattedMessage")
  95. Console.WriteLine("Logger {0}: {1}", eventData.Payload[2], eventData.Payload[4]);
  96. }
  97. }
  98. </summary>
  99. </member>
  100. <member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords">
  101. <summary>
  102. This is public from an EventSource consumer point of view, but since these defintions
  103. are not needed outside this class
  104. </summary>
  105. </member>
  106. <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Meta">
  107. <summary>
  108. Meta events are events about the LoggingEventSource itself (that is they did not come from ILogger
  109. </summary>
  110. </member>
  111. <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Message">
  112. <summary>
  113. Turns on the 'Message' event when ILogger.Log() is called. It gives the information in a programmatic (not formatted) way
  114. </summary>
  115. </member>
  116. <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.FormattedMessage">
  117. <summary>
  118. Turns on the 'FormatMessage' event when ILogger.Log() is called. It gives the formatted string version of the information.
  119. </summary>
  120. </member>
  121. <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.JsonMessage">
  122. <summary>
  123. Turns on the 'MessageJson' event when ILogger.Log() is called. It gives JSON representation of the Arguments.
  124. </summary>
  125. </member>
  126. <member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Instance">
  127. <summary>
  128. The one and only instance of the LoggingEventSource.
  129. </summary>
  130. </member>
  131. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.FormattedMessage(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,System.String)">
  132. <summary>
  133. FormattedMessage() is called when ILogger.Log() is called. and the FormattedMessage keyword is active
  134. This only gives you the human readable formatted message.
  135. </summary>
  136. </member>
  137. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Message(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.Int32,System.String,Microsoft.Extensions.Logging.EventSource.ExceptionInfo,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
  138. <summary>
  139. Message() is called when ILogger.Log() is called. and the Message keyword is active
  140. This gives you the logged information in a programmatic format (arguments are key-value pairs)
  141. </summary>
  142. </member>
  143. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ActivityStart(System.Int32,System.Int32,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
  144. <summary>
  145. ActivityStart is called when ILogger.BeginScope() is called
  146. </summary>
  147. </member>
  148. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.OnEventCommand(System.Diagnostics.Tracing.EventCommandEventArgs)">
  149. <inheritdoc />
  150. </member>
  151. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.SetFilterSpec(System.String)">
  152. <summary>
  153. Set the filtering specification. null means turn off all loggers. Empty string is turn on all providers.
  154. </summary>
  155. <param name="filterSpec">The filter specification to set.</param>
  156. </member>
  157. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ParseFilterSpec(System.String,Microsoft.Extensions.Logging.LogLevel)">
  158. <summary>
  159. Given a set of specifications Pat1:Level1;Pat1;Level2 ... Where
  160. Pat is a string pattern (a logger Name with a optional trailing wildcard * char)
  161. and Level is a number 0 (Trace) through 5 (Critical).
  162. The :Level can be omitted (thus Pat1;Pat2 ...) in which case the level is 1 (Debug).
  163. A completely empty string act like * (all loggers set to Debug level).
  164. The first specification that 'loggers' Name matches is used.
  165. </summary>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.TryParseLevel(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.LogLevel@)">
  168. <summary>
  169. Parses the level specification (which should look like :N where n is a number 0 (Trace)
  170. through 5 (Critical). It can also be an empty string (which means 1 (Debug) and ';' marks
  171. the end of the specification. This specification should start at spec[curPos]
  172. It returns the value in 'ret' and returns true if successful. If false is returned ret is left unchanged.
  173. </summary>
  174. </member>
  175. <member name="T:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions">
  176. <summary>
  177. Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.
  178. </summary>
  179. </member>
  180. <member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggingBuilder)">
  181. <summary>
  182. Adds an event logger named 'EventSource' to the factory.
  183. </summary>
  184. <param name="builder">The extension method argument.</param>
  185. <returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
  186. </member>
  187. <member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
  188. <summary>
  189. Scope provider that does nothing.
  190. </summary>
  191. </member>
  192. <member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
  193. <summary>
  194. Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
  195. </summary>
  196. </member>
  197. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
  198. <inheritdoc />
  199. </member>
  200. <member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
  201. <inheritdoc />
  202. </member>
  203. <member name="T:Microsoft.Extensions.Logging.NullScope">
  204. <summary>
  205. An empty scope without any logic
  206. </summary>
  207. </member>
  208. <member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
  209. <inheritdoc />
  210. </member>
  211. <member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
  212. <summary>
  213. States a dependency that one member has on another.
  214. </summary>
  215. <remarks>
  216. This can be used to inform tooling of a dependency that is otherwise not evident purely from
  217. metadata and IL, for example a member relied on via reflection.
  218. </remarks>
  219. </member>
  220. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
  221. <summary>
  222. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  223. with the specified signature of a member on the same type as the consumer.
  224. </summary>
  225. <param name="memberSignature">The signature of the member depended on.</param>
  226. </member>
  227. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
  228. <summary>
  229. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  230. with the specified signature of a member on a <see cref="T:System.Type"/>.
  231. </summary>
  232. <param name="memberSignature">The signature of the member depended on.</param>
  233. <param name="type">The <see cref="T:System.Type"/> containing <paramref name="memberSignature"/>.</param>
  234. </member>
  235. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
  236. <summary>
  237. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  238. with the specified signature of a member on a type in an assembly.
  239. </summary>
  240. <param name="memberSignature">The signature of the member depended on.</param>
  241. <param name="typeName">The full name of the type containing the specified member.</param>
  242. <param name="assemblyName">The assembly name of the type containing the specified member.</param>
  243. </member>
  244. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
  245. <summary>
  246. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  247. with the specified types of members on a <see cref="T:System.Type"/>.
  248. </summary>
  249. <param name="memberTypes">The types of members depended on.</param>
  250. <param name="type">The <see cref="T:System.Type"/> containing the specified members.</param>
  251. </member>
  252. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
  253. <summary>
  254. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  255. with the specified types of members on a type in an assembly.
  256. </summary>
  257. <param name="memberTypes">The types of members depended on.</param>
  258. <param name="typeName">The full name of the type containing the specified members.</param>
  259. <param name="assemblyName">The assembly name of the type containing the specified members.</param>
  260. </member>
  261. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
  262. <summary>
  263. Gets the signature of the member depended on.
  264. </summary>
  265. <remarks>
  266. Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
  267. must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
  268. </remarks>
  269. </member>
  270. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
  271. <summary>
  272. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  273. of members depended on.
  274. </summary>
  275. <remarks>
  276. Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
  277. must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
  278. </remarks>
  279. </member>
  280. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
  281. <summary>
  282. Gets the <see cref="T:System.Type"/> containing the specified member.
  283. </summary>
  284. <remarks>
  285. If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
  286. the type of the consumer is assumed.
  287. </remarks>
  288. </member>
  289. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
  290. <summary>
  291. Gets the full name of the type containing the specified member.
  292. </summary>
  293. <remarks>
  294. If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
  295. the type of the consumer is assumed.
  296. </remarks>
  297. </member>
  298. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
  299. <summary>
  300. Gets the assembly name of the specified type.
  301. </summary>
  302. <remarks>
  303. <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName"/> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> is specified.
  304. </remarks>
  305. </member>
  306. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
  307. <summary>
  308. Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
  309. </summary>
  310. </member>
  311. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  312. <summary>
  313. Specifies the types of members that are dynamically accessed.
  314. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  315. bitwise combination of its member values.
  316. </summary>
  317. </member>
  318. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  319. <summary>
  320. Specifies no members.
  321. </summary>
  322. </member>
  323. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  324. <summary>
  325. Specifies the default, parameterless public constructor.
  326. </summary>
  327. </member>
  328. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  329. <summary>
  330. Specifies all public constructors.
  331. </summary>
  332. </member>
  333. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  334. <summary>
  335. Specifies all non-public constructors.
  336. </summary>
  337. </member>
  338. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  339. <summary>
  340. Specifies all public methods.
  341. </summary>
  342. </member>
  343. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  344. <summary>
  345. Specifies all non-public methods.
  346. </summary>
  347. </member>
  348. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  349. <summary>
  350. Specifies all public fields.
  351. </summary>
  352. </member>
  353. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  354. <summary>
  355. Specifies all non-public fields.
  356. </summary>
  357. </member>
  358. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  359. <summary>
  360. Specifies all public nested types.
  361. </summary>
  362. </member>
  363. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  364. <summary>
  365. Specifies all non-public nested types.
  366. </summary>
  367. </member>
  368. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  369. <summary>
  370. Specifies all public properties.
  371. </summary>
  372. </member>
  373. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  374. <summary>
  375. Specifies all non-public properties.
  376. </summary>
  377. </member>
  378. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  379. <summary>
  380. Specifies all public events.
  381. </summary>
  382. </member>
  383. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  384. <summary>
  385. Specifies all non-public events.
  386. </summary>
  387. </member>
  388. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  389. <summary>
  390. Specifies all interfaces implemented by the type.
  391. </summary>
  392. </member>
  393. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  394. <summary>
  395. Specifies all members.
  396. </summary>
  397. </member>
  398. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  399. <summary>
  400. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  401. single code artifact.
  402. </summary>
  403. <remarks>
  404. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  405. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  406. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  407. </remarks>
  408. </member>
  409. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  410. <summary>
  411. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  412. class, specifying the category of the tool and the identifier for an analysis rule.
  413. </summary>
  414. <param name="category">The category for the attribute.</param>
  415. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  416. </member>
  417. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  418. <summary>
  419. Gets the category identifying the classification of the attribute.
  420. </summary>
  421. <remarks>
  422. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  423. for which a message suppression attribute applies.
  424. </remarks>
  425. </member>
  426. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  427. <summary>
  428. Gets the identifier of the analysis tool rule to be suppressed.
  429. </summary>
  430. <remarks>
  431. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  432. properties form a unique check identifier.
  433. </remarks>
  434. </member>
  435. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  436. <summary>
  437. Gets or sets the scope of the code that is relevant for the attribute.
  438. </summary>
  439. <remarks>
  440. The Scope property is an optional argument that specifies the metadata scope for which
  441. the attribute is relevant.
  442. </remarks>
  443. </member>
  444. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  445. <summary>
  446. Gets or sets a fully qualified path that represents the target of the attribute.
  447. </summary>
  448. <remarks>
  449. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  450. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  451. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  452. The analysis tool user interface should be capable of automatically formatting the parameter.
  453. </remarks>
  454. </member>
  455. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  456. <summary>
  457. Gets or sets an optional argument expanding on exclusion criteria.
  458. </summary>
  459. <remarks>
  460. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  461. exclusion where the literal metadata target is not sufficiently precise. For example,
  462. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  463. and it may be desirable to suppress a violation against a statement in the method that will
  464. give a rule violation, but not against all statements in the method.
  465. </remarks>
  466. </member>
  467. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  468. <summary>
  469. Gets or sets the justification for suppressing the code analysis message.
  470. </summary>
  471. </member>
  472. </members>
  473. </doc>