GetIssues(IRule,IQueryExecutionSuccessResult,IssueReferenceRecord,IDictionary<RuleIdOrCategory,IReadOnlyList<ISuppressMessage>>) Method

Gets issues of from .

Syntax

[Extension()]
public static IRuleIssues GetIssues( 
   IRule rule,
   IQueryExecutionSuccessResult queryExecutionSuccessResult,
   IssueReferenceRecord issueReferenceRecord,
   IDictionary<RuleIdOrCategory,IReadOnlyList<ISuppressMessage>> suppressedMessages
)

Parameters

rule: The issues built rule, that can be obtained from NDepend.Issue.IIssue.NDepend.Issue.IIssue.Rule.
queryExecutionSuccessResult: The query execution success result from which issues are inferred.
issueReferenceRecord: If this parameter value equals NDepend.Issue.IssueReferenceRecord.NDepend.Issue.IssueReferenceRecord.Yes, each issue in the returned NDepend.Issue.IRuleIssues object will reference will reference its corresponding record in queryExecutionSuccessResult.Records, through NDepend.Issue.IIssue.NDepend.Issue.IIssue.Record.
suppressedMessages: The usages of System.Diagnostics.CodeAnalysis.SuppressMessageAttribute collection used to infer NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.SuppressedIssues

Remarks

A rule prefix can be warnif count == 0 which means that the value of NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.IsRuleViolated of the returned NDepend.Issue.IRuleIssues can be true even if NDepend.Issue.IRuleIssues.Issues is empty. However if IQueryExecutionSuccessResult.IsARuleViolated is false, NDepend.Issue.IRuleIssues.Issues is empty even if the rule has some match.

The NDepend.TechnicalDebt.DebtSettings object used to infer default values for debt and annual-interest (if these evalues are not provided by ). and used to provide thresholds to compute NDepend.Issue.IIssue.NDepend.Issue.IIssue.Severity, is the NDepend.TechnicalDebt.DebtSettings object that was set in QueryExecutionContext.QueryExecutionContext.DebtSettings.
Calling this method might modify the object because of suppressed issues. If some issues are suppressed, the following properties might return a different result after calling this method: .IQueryExecutionSuccessResult.IsARuleViolated, .IQueryExecutionSuccessResult.MatchedCodeElements, .Records. In such case you can find the suppressed issues in the result NDepend.Issue.IRuleIssues.NDepend.Issue.IRuleIssues.SuppressedIssues.

Requirements

Target Platforms: Windows 11, 10, 8, 7and Linux, MacOS with net10.0, net9.0 or net8.0 installed

Reference

ExtensionMethodsQuery Class
ExtensionMethodsQuery Members
Overload List