Summary

Gets 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["SSCMGet"] class Type type-node

Syntax

[TaskName("sscmget")]
public class SSCMGet : SSCMTask

Examples

Get 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 local files that are writable with the server copy.

<sscmget
    serverconnect="localhost:4900"
    serverlogin="administrator:"
    file="/"
    branch="Widget 1.0"
    repository="Mainline/Widget"
    recursive="true"
    force="true"
    overwrite="true"
/>

Get version 1 of the file 'Mainline/Widget/Widget.java' 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.

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

Get all files and repositories labeled with 'Release 1.0.0' (even those removed from Surround) from repository 'Mainline/Widget' recursively from the 'Widget 1.0' branch to the '${build}/src' directory. Writable local files are overwritten with the server copy.

<sscmget
    serverconnect="localhost:4900"
    serverlogin="administrator:"
    quiet="true"
    file="/"
    branch="Widget 1.0"
    repository="Mainline/Widget"
    recursive="true"
    label="Release 1.0.1"
    destdir="${build}/src"
    overwrite="true"
/>

Remarks

You can get a single file, multiple files, or a repository. A read-only copy of the file is created in the specified directory.

Attributes

Type	Description
TaskName

Properties

Name	Value	Summary
Branch	string	Surround SCM branch name. The default is pulled from the local working directory.
ByLabel	string	Label to search for when getting a file. If a file version is specified, this parameter is ignored.
ByTimestamp	string	Timestamp to use when getting files. Format is yyyymmddhh:mm:ss. If `NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel` is specified, this parameter is ignored. Requires Surround SCM 3.0 or later.
DestinationDirectory	DirectoryInfo	The local directory you want to get the files to. If `NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File` is a repository, a subrepository with the same name as the repository is created and files are copied to it. If `NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File` is specified as / or not set, files are copied to the local directory. If not specified, files are copied to the working directory.
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.SSCMGet.Repository` attribute or the default repository.
Force	bool	Force file retrieval from server regardless of the local copy status. The default is `false`.
IncludeRemoved	bool	Include removed files when getting files by label or timestamp. The default is `true`. Ignored if a label or timestamp is not specified.
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 files. 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	The file version to get. Ignored if a filename is not specified in the `NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File` attribute.
Writable	bool	Make local file editable or writable. The default is `false`.

Methods

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