# <vsshistory>

[This is preliminary documentation and subject to change.]

Generates an XML file showing all changes made to a Visual SourceSafe project/file between specified labels or dates (by a given user).

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
output | file | Output file to save history to (as XML). | True
fromdate | datetime | Start date for comparison. | False
fromlabel | string | The value of the label to start comparing to. If it is not included, the compare will start with the very first history item. | False
recursive | bool | Determines whether to perform the comparison recursively. The default is true. | False
todate | datetime | End date for comparison. | False
tolabel | string | The value of the label to compare up to. If it is not included, the compare will end with the last history item. | False
user | string | Name of the user whose changes you want to see. | False
dbpath | file | The path to the folder that contains "srcsafe.ini". | True
path | string | The Visual SourceSafe project or file path you wish the perform the action on (starting with "$/"). | True
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
password | string | The password to use to login to the SourceSafe database. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
username | string | The name of the user needed to access the Visual SourceSafe database. When no `username` is specified and "Use network name for automatic user log in" is enabled for the Visual SourceSafe database, then the current Windows username will be used to log in. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False

### Examples

- Write all changes between "Release1" and "Release2" to XML file "changelog.xml".

      <vsshistory
          dbpath="C:\VSS\srcsafe.ini"
          path="$/My Project"
          fromlabel="Release1"
          tolabel="Release2"
          output="changelog.xml" />

- Write all changes between January 1st 2004 and March 31st 2004 to XML file "history.xml".

      <vsshistory
          dbpath="C:\VSS\srcsafe.ini"
          path="$/My Project"
          fromdate="01/01/2004"
          todate="03/31/2004"
          output="history.xml"
          />

### Requirements

Assembly: NAnt.Contrib.Tasks (0.93.5002.0)