NDepend.API Documentation
TryLoadRuleFile(IProject,IRuleFileRef,IGroup,String) Method
NDepend.Project Namespace > ExtensionMethodsProject Class > TryLoadRuleFile Method : TryLoadRuleFile(IProject,IRuleFileRef,IGroup,String) Method
The NDepend project used to resolve rule file absolute path from ruleFileRef
The reference to the rule file.
The group of code queries and rules, not null only if this method returns true.
If the method returns false, failureReason is not null not empty, and explains in plain-english why the rule files' code queries and rules haven't been loaded.
Try load code rules and queries defined in the rule file defined by ruleFileRef.
Syntax
[Extension()]
public static bool TryLoadRuleFile( 
   IProject project,
   IRuleFileRef ruleFileRef,
   out IGroup group,
   out string failureReason
)

Parameters

project
The NDepend project used to resolve rule file absolute path from ruleFileRef
ruleFileRef
The reference to the rule file.
group
The group of code queries and rules, not null only if this method returns true.
failureReason
If the method returns false, failureReason is not null not empty, and explains in plain-english why the rule files' code queries and rules haven't been loaded.

Return Value

true if the rules have been properly loaded from the rule file, else returns false.
Requirements

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

See Also

Reference

ExtensionMethodsProject Class
ExtensionMethodsProject Members
Overload List