Summary

Task used to checkout files from Visual Source Safe.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.SourceSafe

Base Types

Task
BaseTask

graph BT Type-->Base0["BaseTask"] click Base0 "/api/NAnt.Contrib.Tasks.SourceSafe/BaseTask" Base0-->Base1["Task"] Type["CheckoutTask"] class Type type-node

Syntax

[TaskName("vsscheckout")]
public sealed class CheckoutTask : BaseTask

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

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
FileTimestamp	FileTimestamp	Set the behavior for timestamps of local files. The default is `FileTimestamp.Current`.
Item	IVSSItem	Inherited from BaseTask
LocalPath	DirectoryInfo	The path to the local working directory.
Login	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, then the current Windows username will be used to log in. Inherited from BaseTask
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 a recursive checkout. The default is `true`.
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	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. Inherited from BaseTask
Writable	bool	Determines whether to leave the file(s) as writable. The default is `true`.

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