IBuildProcess.Load Method

Definition

Namespace

Sandcastle.Core.BuildEngine

Assembly

Sandcastle.Core.dll

Load a help file builder project from the given filename unrelated to the current build process

ISandcastleProject Load(string filename, bool mustExist, bool useFinalValues)

Parameters

filename string

The project to load

mustExist bool

Specify true if the file must exist or false if a new project should be created if the file does not exist.

useFinalValues bool

True to use final evaluated property values, or false to use the unevaluated property values. For builds, this should always be true. If loading the project for editing, it should always be false.

Returns

ISandcastleProject

A reference to the loaded help file builder project

Exceptions

ArgumentException

This is thrown if a filename is not specified or if it does not exist and mustExist is true.