PVCSGetTask Class

Summary

Gets files from a PVCS repository.
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["PVCSGetTask"] class Type type-node

Syntax

[TaskName("pvcsget")]
public sealed class PVCSGetTask : PVCSMultipleEntityTask

Examples

Gets the versioned file called App.ico from the project database specified by the project-database property.

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

Gets the versioned file called App.ico from the project database specified by the project-database property. The file is also locked.

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

Gets all revisions assigned the SYSTEST promotion group from the project database specified by the project-database property. The workfiles are touched after the get operation.

    <pvcsget projectdatabase="${project-database}" includesubprojects="true" promotiongroup="SYSTEST" touch="true">
    <entities>
        <entity name="/"/>
    </entities>
</pvcsget>

Remarks

This task uses the get PCLI command to get the versioned files from PVCS.

Attributes

Type Description
TaskName

Constructors

Name Summary
PVCSGetTask() Constructs and initializes an instance of PVCSGetTask.

Properties

Name Value Summary
BaseProjectPath string
Gets or sets the base project path.
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.
Location string
Gets or sets an alternative location for workfiles.
Lock bool
Gets or sets a value indicating whether revisions involved in the get operation should be locked.
MakeWritable bool
Gets or sets whether the workfiles should be made writable.
MaxDateTime DateTime
Gets or sets the maximum date and time of workfiles to retrieve.
OverrideWorkfileLocation bool
Gets or sets a value indicating whether the workfile location for files should be overridden.
Password string
Gets or sets the password to use when connecting to the project database.
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.
ProjectPath string
Gets or sets the project path to utilize during the operation.
PromotionGroup string
Gets or sets the promotion group to get.
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 get against.
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.
Touch bool
Gets or sets a value indicating whether workfiles should be touched after the get.
UpdateOnly bool
Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the current workfile.
UserId string
Gets or sets the user ID to use when connecting to the project database.
VersionLabel string
Gets or sets the version label to get against.
Workspace string
Gets or sets the workspace to use when connecting to the project database.

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