Sandcastle Help File Builder Documentation
Utility.PriorityFor Method
This is used to obtain the execution priority for a plug-in within the given build step and behavior
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
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.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public static int PriorityFor(
this IEnumerable<ExecutionPoint> executionPoints,
BuildStep step,
ExecutionBehaviors behavior
)VB
<ExtensionAttribute>
Public Shared Function PriorityFor (
executionPoints As IEnumerable(Of ExecutionPoint),
step As BuildStep,
behavior As ExecutionBehaviors
) As IntegerC++
public:
[ExtensionAttribute]
static int PriorityFor(
IEnumerable<ExecutionPoint^>^ executionPoints,
BuildStep step,
ExecutionBehaviors behavior
)F#
[<ExtensionAttribute>]
static member PriorityFor :
executionPoints : IEnumerable<ExecutionPoint> *
step : BuildStep *
behavior : ExecutionBehaviors -> int Parameters
- executionPoints IEnumerable<ExecutionPoint>
- An enumerable list of execution points to search
- step BuildStep
- The build step
- behavior ExecutionBehaviors
- The behavior
Return Value
Int32The 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.