Help
Task Reference
<vsscheckout>|
NAntContrib
Help
Task Reference
<vsscheckout> |
v0.85-rc1 |
[This is preliminary documentation and subject to change.]
Task used to checkout files from Visual Source Safe.
| Attribute | Type | Description | Required |
|---|---|---|---|
| localpath | string | The absolute path to the local working directory. | True |
| 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 source safe project or file path, starting with "$/". | True |
| user | string | The user id to use to login to the SourceSafe database. | 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 |
| 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 |
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"
/>