PVCSAddFilesTask Class

Summary

Adds files to 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["PVCSAddFilesTask"] class Type type-node

Syntax

[TaskName("pvcsaddfiles")]
public sealed class PVCSAddFilesTask : PVCSMultipleEntityTask

Examples

Adds File1.txt and File2.txt to the root level of the project database specified by the project-database property. 

    <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control.">
    <entities>
        <entity name="C:\Data\File1.txt"/>
        <entity name="C:\Data\Folder\File2.txt"/>
    </entities>
</pvcsaddfiles>

Adds File1.txt and File2.txt to the folder project of the project database specified by the project-database property. 

    <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." projectpath="/folder">
    <entities>
        <entity name="C:\Data\File1.txt"/>
        <entity name="C:\Data\Folder\File2.txt"/>
    </entities>
</pvcsaddfiles>

Adds another_file.txt and all files and folders at and below C:\Data to the project database specified by the project-database property. 

    <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." includesubprojects="true">
    <entities>
        <entity name="C:\Data\"/>
        <entity name="C:\Temp\another_file.txt"/>
    </entities>
</pvcsaddfiles>

Adds all files at and below C:\Data\ to the project database specified by the project-database property. Workfiles will be copied to the workfile location and will overwrite any existing files (as dictated by the copymode attribute). The relevant revisions will be locked in PVCS. Added files will be assigned the SYSTEST promotion group. 

    <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Files." copymode="CopyWorkfileWithOverwrite" lock="true" promotiongroup="SYSTEST" includesubprojects="true">
    <entities>
        <entity name="C:\Data\"/>
    </entities>
</pvcsaddfiles>

Remarks

This task uses the addfiles PCLI command to add files to a PVCS repository.

Attributes

Type Description
TaskName

Constructors

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

Properties

Name Value Summary
ArchiveDescription string
Gets or sets the archive description for versioned files.
CopyMode PVCSAddFilesTask.PVCSCopyMode
Gets or sets the copy mode for the operation.
DeleteWorkfiles bool
Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS.
Description string
Gets or sets the description for versioned files.
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.
Lock bool
Gets or sets a value indicating whether versioned files should be locked after being added to PVCS.
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 which added files will be assigned. Setting this attribute to an empty string indicates the versioned files will not be assigned to any promotion group.
PVCSBin string
Gets or sets the location of the PVCS binary command-line tools.
Inherited from PVCSTask
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.
SuppressAddIfExists bool
Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS repository.
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 assign to the added versioned files.
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