Summary

Used to apply a label to a Visual Source Safe item.

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["LabelTask"] class Type type-node

Syntax

[TaskName("vsslabel")]
public sealed class LabelTask : BaseTask

Examples

Label all files in a local sourcesafe database. (Automatically applies the label recursively)

<vsslabel 
          user="myusername" 
          password="mypassword" 
          dbpath="C:\VSS\srcsafe.ini"
          path="$/MyProduct"
          comment="NAnt label"
          label="myLabel"
        />

Label a file in a remote sourcesafe database.

<vsslabel 
          user="myusername" 
          password="mypassword" 
          dbpath="\\MyServer\VSS\srcsafe.ini"
          path="$/MyProduct/myFile.cs"
          comment="NAnt label"
          label="myLabel"
        />

Attributes

Type	Description
TaskName

Fields

Name	Constant Value	Summary
RecursiveFlag	24576	Inherited from BaseTask static

Properties

Name	Value	Summary
Comment	string	The label comment.
Database	VSSDatabase	Inherited from BaseTask
DBPath	FileInfo	The path to the folder that contains "srcsafe.ini". Inherited from BaseTask
Item	IVSSItem	Inherited from BaseTask
Label	string	The name of the label.
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
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

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