History Class

Summary

Generates an XML file showing all changes made to a Visual SourceSafe project/file between specified labels or dates (by a given user).
Assembly
NAnt.Contrib.dll
Namespace
NAnt.Contrib.Tasks.SourceSafe
Base Types
graph BT Type-->Base0["BaseTask"] click Base0 "/api/NAnt.Contrib.Tasks.SourceSafe/BaseTask" Base0-->Base1["Task"] Type["History"] class Type type-node

Syntax

[TaskName("vsshistory")]
public class History : BaseTask

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"
/>

Attributes

Type Description
TaskName

Fields

Name Constant Value Summary
RecursiveFlag 24576
Inherited from BaseTask
static

Properties

Name Value Summary
Database VSSDatabase
Inherited from BaseTask
DBPath FileInfo
The path to the folder that contains "srcsafe.ini".
Inherited from BaseTask
FromDate DateTime
Start date for comparison.
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.
Item IVSSItem
Inherited from BaseTask
Login string
Override to avoid exposing the corresponding attribute to build authors.
Output FileInfo
Output file to save history to (as XML).
Password string
The password to use to login to the SourceSafe database.
Inherited from BaseTask
Path string
The Visual SourceSafe project or file path you wish the perform the action on (starting with "$/").
Inherited from BaseTask
Recursive bool
Determines whether to perform the comparison recursively. The default is true.
ToDate DateTime
End date for comparison.
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.
User string
Name of the user whose changes you want to see.
UserName string
The name of the user needed to access the Visual SourceSafe database. When no NAnt.Contrib.Tasks.SourceSafe.BaseTask.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.
Inherited from BaseTask
Version string
Override to avoid exposing the corresponding attribute to build authors.

Methods

Name Value Summary
ExecuteTask() void
GetFileTimestampFlags(FileTimestamp) int
Gets the SourceSafeTypeLib.VSSFlags value corresponding with the specified NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.
Inherited from BaseTask
Open() void
Opens the Source Safe database and sets the reference to the specified item and version.
Inherited from BaseTask