# <loadproperties>

[This is preliminary documentation and subject to change.]

Loads a file's contents as NAnt properties.

Each line in a .properties file stores a single property, with the name and value separated by an equals sign.

Empty lines and lines that start with a '#' character are skipped.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
file | file | The file to load properties from. | True
encoding | Encoding | The encoding to use when loading the file. The default is the system's current ANSI code page. | False
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False

### Nested Elements:

#### <filterchain>

Chain of filters used to alter the file's content as it is copied.

#### </filterchain>

### Examples

-     <loadproperties file="deployment.properties" />

### Requirements

Assembly: NAnt.Contrib.Tasks (0.93.5002.0)