file::get-checksum

[This is preliminary documentation and subject to change.]

Calculates a checksum for a given file and returns it in a hex string.

Usage

string file::get-checksum(path, algorithm)

Parameters

Name Type Description
path string The file for which to calculate a checksum.
algorithm string The name of hash algorithm to use.

Return Value

The hex-formatted checksum of the specified file.

Exceptions

The function will fail in any of the following circumstances:

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.92.4526.0)