Summary

Checks out files from a Surround SCM repository.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.SurroundSCM

Base Types

ExternalProgramBase
SSCMTask

graph BT Type-->Base0["SSCMTask"] click Base0 "/api/NAnt.Contrib.Tasks.SurroundSCM/SSCMTask" Base0-->Base1["ExternalProgramBase"] Type["SSCMCheckout"] class Type type-node

Syntax

[TaskName("sscmcheckout")]
public class SSCMCheckout : SSCMTask

Examples

Check Out all files and repositories from repository 'Mainline/Widget' recursively from the 'Widget 1.0' branch to the working directory setup for user 'administrator'. This call forces the file retrieval from the server even if the local file is current and overwrites any writable local files with the server copy.

<sscmcheckout
    serverconnect="localhost:4900"
    serverlogin="administrator:"
    file="/"
    branch="Widget 1.0"
    repository="Mainline/Widget"
    recursive="true"
    force="true"
    comment="This is my Check Out comment"
/>

Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively from the 'Widget 1.0' branch to the working directory setup for user 'administrator'. Writable local files are not overwritten, even if they are out of date.

<sscmcheckout
    serverconnect="localhost:4900"
    serverlogin="administrator:"
    quiet="true"
    file="Widget.java"
    branch="Widget 1.0"
    repository="Mainline/Widget"
    overwrite="false"
    writable="true"
    version="1"
    exclusive="true"
/>

Remarks

You can check out single files, multiple files, or a full repository. Surround SCM creates a read-write copy of the files in the working directory.

Attributes

Type	Description
TaskName

Properties

Name	Value	Summary
Branch	string	Surround SCM branch name. The default is pulled from the local working directory.
Comment	string	Comment for the check-out.
Exclusive	bool	Exclusively lock the files. The default is `false`.
ExeName	string	Override ExeName paramater to sscm.exe for Surround SCM. Inherited from SSCMTask
File	string	File or repository name. Can be / or empty, which means the repository specified by the `NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository` attribute or the default repository.
Force	bool	Force file retrieval from server regardless of the local copy status. The default is `false`.
Overwrite	bool	Specifies whether to overwrite local writable files. The default is `false`.
ProgramArguments	string	Gets the command line arguments for the external program. Inherited from SSCMTask
Quiet	bool	Do not list repository and local full path of the Surround SCM server. The default is `false`.
Recursive	bool	Recursively get files and sub-repositories. The default is `false`.
Repository	string	Surround SCM repository path. The default is pulled from the local working directory.
ServerConnect	string	The address and port number of the Surround SCM server host computer. Format is server:port. If not entered, the last saved connection parameters are used. Inherited from SSCMTask
ServerLogin	string	The username and password used to login to the Surround SCM server. Format is username:password. If not entered, the last saved login parameters are used. Inherited from SSCMTask
Timestamp	string	Specifies how to set the local file's date/time. Possible values are `current`, `modify` or `checkin`.
Version	string	Specifies the file version to check out. Ignored if no specific filename is set using the `NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File` attribute.

Methods

Name	Value	Summary
WriteCommandLineArguments(StringBuilder)	void	Writes the task-specific arguments to the specified `System.Text.StringBuilder`.