Utility.RunsAt Method

UtilityRunsAt Method

This is used to determine if the enumerable list of execution points contains an entry for the specified build step and behavior.

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

Syntax

C++

Copy

public static bool RunsAt(
	this IEnumerable<ExecutionPoint> executionPoints,
	BuildStep step,
	ExecutionBehaviors behavior
)

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

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

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

Parameters

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

Return Value

Type: Boolean
True if the enumerable list of execution points contains an entry for the specified build step and behavior or false if it does not.

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