Summary

Checks files out of a ClearCase VOB.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.ClearCase

Base Types

Core.Tasks.ExternalProgramBase
ClearCaseBase

graph BT Type-->Base0["ClearCaseBase"] click Base0 "/api/NAnt.Contrib.Tasks.ClearCase/ClearCaseBase" Base0-->Base1["Core.Tasks.ExternalProgramBase"] Type["ClearCaseCheckOut"] class Type type-node

Syntax

[TaskName("cccheckout")]
public class ClearCaseCheckOut : ClearCaseBase

Examples

Performs a ClearCase checkout on the file c:/views/viewdir/afile. It is checked out as reserved on branch called abranch. All warning messages are suppressed. Some comment text is added to ClearCase as a comment.

<cccheckout viewpath="c:/views/viewdir/afile"
    reserved="true"
    branch="abranch"
    nowarn="true"
    comment="Some comment text"/>

Remarks

This task uses the cleartool checkout command to check out ClearCase elements.

Attributes

Type	Description
TaskName

Properties

Name	Value	Summary
Branch	string	Specify a branch to check out the file to.
CommandSpecificArguments	string	This is an override used by the base class to get command specific args.
Comment	string	Specify a comment. Only one of `NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment` or `NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile` may be used.
CommentFile	FileInfo	Specify a file containing a comment. Only one of `NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment` or `NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile` may be used.
NoData	bool	If `true`, checks out the file but does not create an editable file containing its data. Default is `false`.
NoWarn	bool	`true` if warning messages should be suppressed. The default is `false`.
OutFile	FileInfo	Creates a writable file under a different filename.
PreserveTime	bool	If `true`, the modification time will be preserved. Default is `false`.
ProgramArguments	string	Overrides the base class. Inherited from ClearCaseBase
Reserved	bool	`true` to check the element out as reserved. Default is `true`.
Version	bool	If `true`, checkouts of elements with a version other than main latest will be allowed. Default is `false`.
ViewPath	FileInfo	Path to the ClearCase view file or directory that the command will operate on.

Methods

Name	Value	Summary
ExecuteTask()	void	Execute the perforce command assembled by subclasses. Inherited from ClearCaseBase

ClearCaseCheckOut Class