Utility.PriorityFor Method

UtilityPriorityFor Method

This is used to obtain the execution priority for a plug-in in the given build step and behavior

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public static int PriorityFor(
	this IEnumerable<ExecutionPoint> executionPoints,
	BuildStep step,
	ExecutionBehaviors behavior
)

<ExtensionAttribute>
Public Shared Function PriorityFor ( 
	executionPoints As IEnumerable(Of ExecutionPoint),
	step As BuildStep,
	behavior As ExecutionBehaviors
) As Integer

public:
[ExtensionAttribute]
static int PriorityFor(
	IEnumerable<ExecutionPoint^>^ executionPoints, 
	BuildStep step, 
	ExecutionBehaviors behavior
)

[<ExtensionAttribute>]
static member PriorityFor : 
        executionPoints : IEnumerable<ExecutionPoint> * 
        step : BuildStep * 
        behavior : ExecutionBehaviors -> int

Parameters

executionPoints: Type: System.Collections.GenericIEnumerableExecutionPoint
An enumerable list of execution points to search
step: Type: SandcastleBuilder.Utils.BuildEngineBuildStep
The build step
behavior: Type: SandcastleBuilder.Utils.BuildComponentExecutionBehaviors
The behavior

Return Value

Type: Int32
The execution priority is used to determine the order in which the plug-ins will be executed. Those with a higher priority value will be executed before those with a lower value. Those with an identical priority may be executed in any order within their group.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableExecutionPoint. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

Utility Class

SandcastleBuilder.Utils Namespace