Summary

Unlocks revisions of versioned files in a PVCS repository.

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

Syntax

[TaskName("pvcsunlock")]
public sealed class PVCSUnlockTask : PVCSMultipleEntityTask

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>

Remarks

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

Attributes

Type	Description
TaskName

Constructors

Name	Summary
PVCSUnlockTask()	Constructs and initializes an instance of `PVCSUnlock`.

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. Inherited from PVCSProjectDatabaseTask
Password	string	Gets or sets the password to use when connecting to the project database. Inherited from PVCSProjectDatabaseTask
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. Inherited from PVCSProjectDatabaseTask
ProjectPath	string	Gets or sets the project path to utilize during the operation. Inherited from PVCSProjectDatabaseTask
PVCSBin	string	Gets or sets the location of the PVCS binary command-line tools. Inherited from PVCSTask
Revision	double	Gets or sets the revision number to use for the new revision.
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. Inherited from PVCSProjectDatabaseTask
UnlockMode	PVCSUnlockTask.PVCSUnlockMode	Gets or sets the unlock mode for the operation.
User	string	Gets or sets the user whose locked files are to be unlocked. This is relevant only when `NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode` is set to `NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser`.
UserId	string	Gets or sets the user ID to use when connecting to the project database. Inherited from PVCSProjectDatabaseTask
Workspace	string	Gets or sets the workspace to use when connecting to the project database. Inherited from PVCSProjectDatabaseTask

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

PVCSUnlockTask Class