Summary

Locks a revision of the specified versioned files.

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

Syntax

[TaskName("pvcslock")]
public sealed class PVCSLockTask : PVCSMultipleEntityTask

Examples

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

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

Locks all files at and below folder in the project database specified by the project-database property.

    <pvcslock projectdatabase="${project-database}" includesubprojects="true">
    <entities>
        <entity name="/folder"/>
    </entities>
</pvcslock>

Remarks

This task uses the lock PCLI command to lock the versioned files.

Attributes

Type	Description
TaskName

Constructors

Name	Summary
PVCSLockTask()	Constructs and initializes an instance of `PVCSLock`.

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
NoBranching	bool	Gets or sets a value indicating whether locking files will take place if checking in those files would result in a branch.
NoMultilock	bool	Gets or sets a value indicating whether already locked revisions will be locked.
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
PromotionGroup	string	Gets or sets the promotion group to assign the locked revision.
PVCSBin	string	Gets or sets the location of the PVCS binary command-line tools. Inherited from PVCSTask
Revision	double	Gets or sets the revision to lock.
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
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
YesToBranching	bool	Gets or sets a value indicating whether revisions will be locked even if that will result in a branch upon check in.
YesToMultilock	bool	Gets or sets a value indicating whether revisions will be locked even if that will result in multiple locks against the same revision.

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

PVCSLockTask Class