environment::get-folder-path

[This is preliminary documentation and subject to change.]

Gets the path to the system special folder identified by the specified enumeration.

Usage

string environment::get-folder-path(folder)

Parameters

Name Type Description
folder SpecialFolder An enumerated constant that identifies a system special folder.

Return Value

The path to the specified system special folder, if that folder physically exists on your computer; otherwise, the empty string ("").

Exceptions

The function will fail in any of the following circumstances:

Examples

Requirements

Assembly: NAnt.Core (0.91.3881.0)