TryGetAnalysisResultRefToCompareWith(IProjectBaseline,IAnalysisResultRef,String) Method

Try gets an analysis reference corresponding to this project baseline to compare with.

Syntax

[Extension()]
public static TryGetAnalysisResultRefToCompareWithResult TryGetAnalysisResultRefToCompareWith( 
   IProjectBaseline projectBaseline,
   out IAnalysisResultRef analysisResultRef,
   out string failureReason
)

Parameters

projectBaseline: This NDepend project baseline, obtained from IProject.NDepend.Project.IProject.BaselineDuringAnalysis or IProject.NDepend.Project.IProject.BaselineInUI.
analysisResultRef: If the method returns TryGetAnalysisResultRefToCompareWithResult.TryGetAnalysisResultRefToCompareWithResult.DoCompareWith, analysisResultRef is not null and references the analysis result used for baseline.
failureReason: If the method returns TryGetAnalysisResultRefToCompareWithResult.TryGetAnalysisResultRefToCompareWithResult.ErrorGettingTheAnalysisResultRef, failureReason is not null not empty, and explains in plain-english why the project baseline cannot be retrieved.

Return Value

TryGetAnalysisResultRefToCompareWithResult.TryGetAnalysisResultRefToCompareWithResult.DoCompareWith if an an analysis result reference representing the baseline to compare with can be found, else returns another value of the enumeration TryGetAnalysisResultRefToCompareWithResult.

Requirements

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

Reference

ExtensionMethodsProjectAnalysis Class
ExtensionMethodsProjectAnalysis Members
Overload List