<vsscheckout>

Task used to checkout files from Visual Source Safe.

Parameters

Attribute Type Description Required
localpath string The absolute path to the local working directory. Required. True
recursive string Determines whether to perform a recursive checkout. Default value is true when omitted. False
writable string Determines whether to leave the file(s) as writable. Default value is true when omitted. False
dbpath string The absolute path to the folder that contains the srcsafe.ini. Required. True
path string The source safe project or file path, starting with "$/". Required. True
user string The user id to use to login to the Source Safe database. Required. True
failonerror bool False
if bool False
password string The password to use to login to the Source Safe database. False
unless bool False
verbose bool 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"
                />