Help
Task Reference
<pvcsdeletelabel>|
NAntContrib
Help
Task Reference
<pvcsdeletelabel> |
v0.85-rc1 |
[This is preliminary documentation and subject to change.]
Removes a label from specified versioned files or projects.
This task uses the deletelabel PCLI command to remove the version label from the versioned files.
| Attribute | Type | Description | Required |
|---|---|---|---|
| versionlabel | string | Gets or sets the version label to remove. | True |
| projectdatabase | string | Gets or sets the project database to utilize during the operation. | 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 |
| includesubprojects | bool | Gets or sets a value indicating whether the operation should include subprojects. | False |
| password | string | Gets or sets the password to use when connecting to the project database. | False |
| projectpath | string | Gets or sets the project path to utilize during the operation. | False |
| pvcsbin | string | Gets or sets the location of the PVCS binary command-line tools. | False |
| timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False |
| unless | bool | Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. |
False |
| userid | string | Gets or sets the user ID to use when connecting to the project database. | False |
| verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False |
| workspace | string | Gets or sets the workspace to use when connecting to the project database. | False |
| Attribute | Type | Description | Required |
|---|---|---|---|
| useruntimeengine | bool | Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. | False |
Contains a collection of Argument elements.
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>