[This is preliminary documentation and is subject to change.]

Makes sure that the path format is valid, that it exists, that it is accessible and writeable.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.3.5 (0.6.3.5)

Syntax


	C#

public static bool TestDirectory(
	string pathLabel,
	string path,
	bool checkForWriteAccess
)

Parameters

pathLabel: String
Name of the path that's being tested (e.g. "map path"). Used for logging.

path: String
Full or partial path.

checkForWriteAccess: Boolean
If set, tries to write to the given directory.

Return Value

Full path of the directory (on success) or null (on failure).

Exceptions

Exception	Condition
System..::..ArgumentNullException	pathLabel or path is null.

See Also

fCraft Namespace