| BuildProcessVerifySafePath Method |
Make sure the path isn't one the user would regret having nuked without warning
Namespace: SandcastleBuilder.Utils.BuildEngineAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax public static void VerifySafePath(
string propertyName,
string propertyValue,
string projectPath
)
Public Shared Sub VerifySafePath (
propertyName As String,
propertyValue As String,
projectPath As String
)
public:
static void VerifySafePath(
String^ propertyName,
String^ propertyValue,
String^ projectPath
)
static member VerifySafePath :
propertyName : string *
propertyValue : string *
projectPath : string -> unit
Parameters
- propertyName
- Type: SystemString
The name of the path property - propertyValue
- Type: SystemString
It's current value - projectPath
- Type: SystemString
The path to the current project
Exceptions Exception | Condition |
---|
BuilderException | This is thrown if the path is one of the ones that probably should
not be used. |
Remarks Since most people don't read the help file and also ignore the warning in the property grid
description pane, we'll take some steps to idiot-proof the dangerous path properties. I'm starting
to lose count of the number of people that point WorkingPath at the root of their C:\ drive and
wonder why all their files disappear.
Paths checked for include root references to hard drives and network shares, most common
well-known folders, and the project's root folder.
See Also