SandcastleProject(String, Boolean, Boolean) Constructor
Load a Sandcastle Builder project from the given filename
Namespace: SandcastleBuilder.UtilsAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
public SandcastleProject(
string filename,
bool mustExist,
bool useFinalValues
)
Public Sub New (
filename As String,
mustExist As Boolean,
useFinalValues As Boolean
)
public:
SandcastleProject(
String^ filename,
bool mustExist,
bool useFinalValues
)
new :
filename : string *
mustExist : bool *
useFinalValues : bool -> SandcastleProject
Parameters
- filename String
- The filename to load
- mustExist Boolean
- Specify true if the file must exist or false if a new project should be
created if the file does not exist.
- useFinalValues Boolean
- 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.
ArgumentException | This is thrown if a filename is not specified or if it does not
exist and mustExist is true. |