framework::get-tool-path

[This is preliminary documentation and subject to change.]

Gets the absolute path of the specified tool for the current target framework.

Usage

string framework::get-tool-path(tool)

Parameters

Name Type Description
tool string The file name of the tool to search for.

Return Value

The absolute path to tool if found in one of the configured tool paths; otherwise, an error is reported.

Exceptions

The function will fail in any of the following circumstances:

Remarks

The configured tool paths are scanned in the order in which they are defined in the framework configuration.

The file name of the tool to search should include the extension.

Examples

Requirements

Assembly: NAnt.Core (0.91.4298.0)