PVCSDeleteLabelTask Class

Summary

Removes a label from specified versioned files or projects.
Assembly
NAnt.Contrib.dll
Namespace
NAnt.Contrib.Tasks.PVCS
Base Types
graph BT Type-->Base0["PVCSMultipleEntityTask"] click Base0 "/api/NAnt.Contrib.Tasks.PVCS/PVCSMultipleEntityTask" Base0-->Base1["PVCSProjectDatabaseTask"] click Base1 "/api/NAnt.Contrib.Tasks.PVCS/PVCSProjectDatabaseTask" Base1-->Base2["PVCSTask"] click Base2 "/api/NAnt.Contrib.Tasks.PVCS/PVCSTask" Base2-->Base3["ExternalProgramBase"] Type["PVCSDeleteLabelTask"] class Type type-node

Syntax

[TaskName("pvcsdeletelabel")]
public sealed class PVCSDeleteLabelTask : PVCSMultipleEntityTask

Examples

Removes the label called My Label from the versioned file called App.ico from the project database specified by the project-database property. 

    <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label">
    <entities>
        <entity name="/App.ico"/>
    </entities>
</pvcsdeletelabel>

Removes the label called My Label from all files at and below both folder1 and folder2 in the project database specified by the project-database property. 

    <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label" includesubprojects="true">
    <entities>
        <entity name="/folder1"/>
        <entity name="/folder2"/>
    </entities>
</pvcsdeletelabel>

Remarks

This task uses the deletelabel PCLI command to remove the version label from the versioned files.

Attributes

Type Description
TaskName

Properties

Name Value Summary
Entities EntitySet
Gets or sets the entities involved in the operation.
Inherited from PVCSMultipleEntityTask
ExeName string
Gets the executable name for the command-line tool to run for the PVCS task.
Inherited from PVCSTask
IncludeSubprojects bool
Gets or sets a value indicating whether the operation should include subprojects.
Password string
Gets or sets the password to use when connecting to the project database.
PCLICommandName string
Gets the PCLI command name that corresponds to the operation the task performs.
Inherited from PVCSTask
ProgramArguments string
Gets the program arguments with which to run the wrapped PVCS process.
Inherited from PVCSTask
ProjectDatabase string
Gets or sets the project database to utilize during the operation.
ProjectPath string
Gets or sets the project path to utilize during the operation.
PVCSBin string
Gets or sets the location of the PVCS binary command-line tools.
Inherited from PVCSTask
SupportsIncludeSubprojects bool
Gets a value indicating whether the specific task implementation supports the includesubprojects task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.
UserId string
Gets or sets the user ID to use when connecting to the project database.
VersionLabel string
Gets or sets the version label to remove.
Workspace string
Gets or sets the workspace to use when connecting to the project database.

Methods

Name Value Summary
AddCommandLineArguments(PVCSCommandArgumentCollection) void
ExecuteTask() void
Executes the task.
Inherited from PVCSTask
PrepareProcess(Process) void
Prepares the process wrapped by this task for execution.
Inherited from PVCSTask
StartProcess() Process
Starts the process that is wrapped by this PVCS task.
Inherited from PVCSTask