<pvcsunlock>

[This is preliminary documentation and subject to change.]

Unlocks revisions of versioned files in a PVCS repository.

This task uses the unlock PCLI command to perform the unlock operation.

Parameters

Attribute	Type	Description	Required
revision	double	Gets or sets the revision number to use for the new revision.	False
unlockmode	PVCSUnlockMode	Gets or sets the unlock mode for the operation.	False
user	string	Gets or sets the user whose locked files are to be unlocked. This is relevant only when `unlockmode` is set to `SpecifiedUser`.	False
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

Framework-configurable parameters

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

Nested Elements:

<entities>

Gets or sets the entities involved in the operation.

</entities>

<arg>

The command-line arguments for the external program.

Contains a collection of Argument elements.

</arg>

Examples

Unlocks App.ico in the project database specified by the project-database property.

<pvcsunlock projectdatabase="${project-database}">
    <entities>
        <entity name="/App.ico"/>
    </entities>
</pvcsunlock>

Unlocks all files in the project specified by the project-database property. Locks by all users are removed.

<pvcsunlock projectdatabase="${project-database}" includesubprojects="true" unlockmode="AllUsers">
    <entities>
        <entity name="/"/>
    </entities>
</pvcsunlock>

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1793.0)