BuildProcessVerifySafePath Method

Make sure the path isn't one the user would regret having nuked without warning

Definition

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

C#View Source Request Example

public static void VerifySafePath(
	string propertyName,
	string propertyValue,
	string projectPath
)

VBView Source Request Example

Public Shared Sub VerifySafePath ( 
	propertyName As String,
	propertyValue As String,
	projectPath As String
)

C++View Source Request Example

public:
static void VerifySafePath(
	String^ propertyName, 
	String^ propertyValue, 
	String^ projectPath
)

F#View Source Request Example

static member VerifySafePath : 
        propertyName : string * 
        propertyValue : string * 
        projectPath : string -> unit

Parameters

propertyName String: The name of the path property
propertyValue String: It's current value
projectPath String: The path to the current project

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.

Exceptions

BuilderException

This is thrown if the path is one of the ones that probably should not be used.

BuildProcessVerifySafePath Method

Definition

Parameters

Remarks

Exceptions

See Also

Reference