NDepend.API Documentation
RunAnalysisAndBuildReport(IProject,String) Method
NDepend.Analysis Namespace > ExtensionMethodsProjectAnalysis Class > RunAnalysisAndBuildReport Method : RunAnalysisAndBuildReport(IProject,String) Method
This NDepend project to analyze.
(Optional) An id to identify the analysis result build by this call.
Runs a full analysis on this project, in-process and synchronously, and then generate a HTML report. (Only available with a Build Machine license).
Syntax
[Extension()]
public static IAnalysisResult RunAnalysisAndBuildReport( 
   IProject project,
   string analysisResultId
)

Parameters

project
This NDepend project to analyze.
analysisResultId
(Optional) An id to identify the analysis result build by this call.

Return Value

The analysis result.
Exceptions
ExceptionDescription
Cannot run analysis without a Build Machine license.
The analysis execution failed. The InnerException contains additional information concerning the failure.
The string for analysisResultId is invalid. It must be trimmed, a length of maximum 64 characters, excluding characters that cannot fit in a file name \ / : * ? " > < |
Remarks
The report generated is available in project.Properties.NDepend.Project.IProjectProperties.OutputDir, named "NDependReport.html".
Calling this method will typically takes a few seconds, the time the analysis is performed.
The analysis result is persisted in the project.Properties.NDepend.Project.IProjectProperties.OutputDir directory.
It is possible to run several analysis simultaneously on several threads in the same AppDomain.
Requirements

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

See Also

Reference

ExtensionMethodsProjectAnalysis Class
ExtensionMethodsProjectAnalysis Members
Overload List