PVCSDeleteUsersTask Class

Summary

Deletes the specified users from the PVCS access control database.
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["PVCSDeleteUsersTask"] class Type type-node

Syntax

[TaskName("pvcsdeleteusers")]
public sealed class PVCSDeleteUsersTask : PVCSMultipleEntityTask

Examples

Deletes the users called kb, kv and tb from the project database specified by the project-database property. 

    <pvcsdeleteusers projectdatabase="${project-database}">
    <entities>
        <entity name="kb"/>
        <entity name="kv"/>
        <entity name="tb"/>
    </entities>
</pvcsdeleteusers>

Remarks

This task uses the deleteuser PCLI command to delete the users.

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
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
UserId string
Gets or sets the user ID to use when connecting to the project database.
Workspace string
Gets or sets the workspace to use when connecting to the project database.

Methods

Name Value Summary
AddCommandLineArguments(PVCSCommandArgumentCollection) void
Inherited from PVCSMultipleEntityTask
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