BuildProcess.ReportProgress Method (BuildStep, String, Object[])

BuildProcessReportProgress Method (BuildStep, String, Object)

This is used to report progress during the build process and possibly update the current step

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

Syntax

protected void ReportProgress(
	BuildStep step,
	string message,
	params Object[] args
)

Protected Sub ReportProgress ( 
	step As BuildStep,
	message As String,
	ParamArray args As Object()
)

protected:
void ReportProgress(
	BuildStep step, 
	String^ message, 
	... array<Object^>^ args
)

member ReportProgress : 
        step : BuildStep * 
        message : string * 
        args : Object[] -> unit

step: Type: SandcastleBuilder.Utils.BuildEngineBuildStep
The current build step
message: Type: SystemString
The message to report
args: Type: SystemObject
A list of arguments to format into the message text

Events

Event Type	Reason
BuildProcessBuildStepChanged	This event fires when the current build step changes
BuildProcessBuildProgress	This event fires to report progress information