<vsscheckout>

[This is preliminary documentation and subject to change.]

Task used to checkout files from Visual Source Safe.

Parameters

Attribute	Type	Description	Required
localpath	directory	The path to the local working directory.	True
filetimestamp	FileTimestamp	Set the behavior for timestamps of local files. The default is `Current`.	False
recursive	bool	Determines whether to perform a recursive checkout. The default is true.	False
writable	bool	Determines whether to leave the file(s) as writable. The default is true.	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
user	string	Deprecated. 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, then the current Windows username will be used to log in.	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
version	string	A version of the path to reference. Accepts multiple forms, including the label, version number, or date of the version. If omitted, the latest version is used.	False

Examples

Checkout the latest files from a local sourcesafe database.

                <vsscheckout 
                  user="myusername" 
                  password="mypassword" 
                  localpath="C:\Dev\Latest"
                  recursive="true"
                  writable="true"
                  dbpath="C:\VSS\srcsafe.ini"
                  path="$/MyProduct"
                />

Checkout a file from a remote sourcesafe database. Put it in a relative directory.

                <vsscheckout 
                  user="myusername" 
                  password="mypassword" 
                  localpath="Latest"
                  recursive="false"
                  writable="true"
                  dbpath="\\MyServer\VSS\srcsafe.ini"
                  path="$/MyProduct/myFile.cs"
                />

Requirements

Assembly: NAnt.Contrib.Tasks (0.92.4537.0)