AdditionalReferenceLinksPlugIn.Initialize Method

AdditionalReferenceLinksPlugInInitialize Method

This method is used to initialize the plug-in at the start of the build process.

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

Syntax

C++

Copy

public void Initialize(
	BuildProcess buildProcess,
	XPathNavigator configuration
)

Public Sub Initialize ( 
	buildProcess As BuildProcess,
	configuration As XPathNavigator
)

public:
virtual void Initialize(
	BuildProcess^ buildProcess, 
	XPathNavigator^ configuration
) sealed

abstract Initialize : 
        buildProcess : BuildProcess * 
        configuration : XPathNavigator -> unit 
override Initialize : 
        buildProcess : BuildProcess * 
        configuration : XPathNavigator -> unit

Parameters

buildProcess: Type: SandcastleBuilder.Utils.BuildEngineBuildProcess
A reference to the current build process.
configuration: Type: System.Xml.XPathXPathNavigator
The configuration data that the plug-in should use to initialize itself.

Implements

IPlugInInitialize(BuildProcess, XPathNavigator)

Exceptions

Exception	Condition
BuilderException	This is thrown if the plug-in configuration is not valid.

Reference

AdditionalReferenceLinksPlugIn Class

SandcastleBuilder.PlugIns Namespace