Summary

Encapsulates the details of a PVCS command argument.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.PVCS

Interfaces

IComparable

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IComparable"] Type["PVCSCommandArgument"] class Type type-node

Syntax

public sealed class PVCSCommandArgument : IComparable

Remarks

PVCS tasks must "fill in" a collection of arguments to be passed to the PVCS command line interface (PCLI). This class represents one such argument.

Each argument consists of a command and an optional command value. The command is always passed to the PVCS command line utility and is therefore required. An example of a command is "-g" which is passed to many PVCS command line utilities to specify a promotion group.

The command value is used to specify extra information to the command. For example, if the command is "-g" then the command value would be the name of the promotion group.

The command can be assigned a position (see the NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position property). This position defines where the command appears relative to other commands. For example, some commands must appear after other commands. Therefore, they should be assigned a position of NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start.

Constructors

Name	Summary
PVCSCommandArgument(string)	Constructs an instance of `PVCSCommandArgument` with the specified information. No value is applied and the argument has a position of `NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle`.
PVCSCommandArgument(string, Object)	Constructs an instance of `PVCSCommandArgument` with the specified information. The argument has a position of `NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle`.
PVCSCommandArgument(string, Object, PVCSCommandArgumentPosition)	Constructs an instance of `PVCSCommandArgument` with the specified information.

Properties

Name	Value	Summary
Command	string	Gets a `string` that contains the command to pass to PVCS.
CommandValue	Object	Gets the value to append to `NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command`.
Position	PVCSCommandArgumentPosition	Gets the position for the command.

Methods