<cclock>

[This is preliminary documentation and subject to change.]

Locks ClearCase elements.

This task uses the cleartool lock command to lock ClearCase elements.

Parameters

Attribute Type Description Required
comment string Specify a comment. Only one of comment or commentfile may be used. False
commentfile file Specify a file containing a comment. Only one of comment or commentfile may be used. False
nusers string Specifies user(s) who can still modify the object. Only one of nusers or obsolete may be used. False
objsel string Specifies the object(s) to be locked. False
obsolete bool If true the object will be marked obsolete. Only one of nusers or obsolete may be used. Default is false. False
pname string Specifies the object pathname to be locked. False
replace bool If true an existing lock can be replaced. Default is false. False
failonerror bool Determines if task failure stops the build, or is just reported. The default is true. False
if bool If true then the task will be executed; otherwise, skipped. The default is true. False
timeout int The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unless bool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbose bool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

Attribute Type Description Required
exename string The name of the executable that should be used to launch the external program. False
useruntimeengine bool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

Represents a command-line argument.

Parameters

AttributeTypeDescriptionRequired
dirdirectory The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. False
filefile The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. False
ifbool Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true. False
linestring List of command-line arguments; will be passed to the executable as is. False
path<path> The value for a PATH-like command-line argument; you can use : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. False
unlessbool Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false. False
valuestring A single command-line argument; can contain space characters. False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.2395.0)

See Also

<ccunlock>