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.

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

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

The hex-formatted checksum of the specified file.

The function will fail in any of the following circumstances:

The specified file does not exist.
path is a zero-length string, contains only white space, or contains one or more invalid characters.
-or-
algorithm is not a valid name of a hash algorithm.
The specified path, file name, or both exceed the system-defined maximum length.
The path parameter is in an invalid format.

Displays the MD5 checksum of a file.

<echo>Checksum=${file::get-checksum('Cegeka.exe', 'MD5')}"></echo>

Assembly: NAnt.Contrib.Tasks (0.92.4526.0)