DepthOfIsUsedBy Method (ExtensionMethodsCQLinqDependency)

The NDepend.CodeModel.ICodeElement.FullName of the code element user.
The string can contain wildcard '*' characters but cannot be just a single wildcard string "*".
If one or several code elements are matched by , this method has a used by any behavior.

If matches several code elements of different kinds (like some assemblies and some namespaces) a compilation resolving error is emitted.
To solve this issue, the string can be prefixed with "ASSEMBLY:", "NAMESPACE:", "TYPE:", "METHOD:", "FIELD:", "PROPERTY:" or "EVENT:" to precise the kind of code element to match.
Alternatively, the string extensions methods MatchAssembly, MatchNamespace, MatchType, MatchMethod, MatchField, MatchProperty or MatchEvent can be used instead, to insert this prefix.

If no code element is matched by , the CQLinq query will emit a compilation error, except if is prefixed with "OPTIONAL:".
Alternatively, the string extensions methods AllowNoMatch can be used instead, to insert the "OPTIONAL:" prefix.

Returns a non-null depth of usage value, if is directly or indirectly used by a NDepend.CodeModel.ICodeElement whose NDepend.CodeModel.ICodeElement.FullName is . This method can only be called in a ICQLinqExecutionContext, otherwise the extension method NDepend.CodeModel.ExtensionMethodsSequenceUsage.NDepend.CodeModel.ExtensionMethodsSequenceUsage.DepthOfIsUsedByAny<TUsed,TUser> must be called instead.

Syntax

[Extension()]
public static Nullable<ushort> DepthOfIsUsedBy( 
   IUsed usedCodeElement,
   string userCodeElementFullName
)

Parameters

usedCodeElement: This NDepend.CodeModel.IUsed object. A NDepend.CodeModel.IUsed object can be a NDepend.CodeModel.IAssembly, NDepend.CodeModel.INamespace, NDepend.CodeModel.IMember, NDepend.CodeModel.IType, NDepend.CodeModel.IMethod or NDepend.CodeModel.IField object.
userCodeElementFullName: The NDepend.CodeModel.ICodeElement.FullName of the code element user.
The string userCodeElementFullName can contain wildcard '*' characters but cannot be just a single wildcard string "*".
If one or several code elements are matched by userCodeElementFullName, this method has a used by any behavior.

If userCodeElementFullName matches several code elements of different kinds (like some assemblies and some namespaces) a compilation resolving error is emitted.
To solve this issue, the string can be prefixed with "ASSEMBLY:", "NAMESPACE:", "TYPE:", "METHOD:", "FIELD:", "PROPERTY:" or "EVENT:" to precise the kind of code element to match.
Alternatively, the string extensions methods MatchAssembly, MatchNamespace, MatchType, MatchMethod, MatchField, MatchProperty or MatchEvent can be used instead, to insert this prefix.

If no code element is matched by userCodeElementFullName, the CQLinq query will emit a compilation error, except if userCodeElementFullName is prefixed with "OPTIONAL:".
Alternatively, the string extensions methods AllowNoMatch can be used instead, to insert the "OPTIONAL:" prefix.

Return Value

userCodeElement being a NDepend.CodeModel.ICodeElement whose NDepend.CodeModel.ICodeElement.FullName is :
Returns null if is not directly nor indirectly used by a userCodeElement.
Returns 0 if is, or belongs to, a userCodeElement.
Returns 1 if is directly used by a userCodeElement.
Returns 2 if is directly used by a code element that is directly used by a userCodeElement.
...
If a non-null number is returned, returns the lowest possible number.

Exceptions

Exception	Description
System.NotImplementedException	This extension method cannot be called from a program consuming NDepend.API. In such context, the extension method NDepend.CodeModel.ExtensionMethodsSequenceUsage.NDepend.CodeModel.ExtensionMethodsSequenceUsage.DepthOfIsUsedByAny<TUsed,TUser> must be called instead.

Remarks

If one or several code elements are matched by , they will be listed in NDepend.CodeQuery.IQueryExecutionSuccessResult.TargetCodeElements.
In the context of a CQLinq compiled query, this method has a constant time complexity.

Requirements

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

Reference

ExtensionMethodsCQLinqDependency Class
ExtensionMethodsCQLinqDependency Members
IsIndirectlyUsedBy Method
MatchAssembly Method
MatchNamespace Method
MatchType Method
MatchMethod Method
MatchField Method
MatchProperty Method
MatchEvent Method
AllowNoMatch Method