<vssget>

[This is preliminary documentation and subject to change.]

Used to retrieve an item or project from a Visual Source Safe database.

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 the get recursively. The default is true. False
removedeleted bool If Path refers to a project, determines whether files marked "deleted" in the repository will be removed from the local copy. The default is false. False
replace bool Determines whether to replace writable files. The default is false. False
usemodtime bool Deprecated. Determines whether the timestamp on the local copy will be the modification time (if false or omitted, the checkout time will be used) False
writable bool Determines whether the files will be writable. The default is false. 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

Requirements

Assembly: NAnt.Contrib.Tasks (0.86.3319.0)